From 13dc44d1746afb98fc9d1d4c807df87e2ffed942 Mon Sep 17 00:00:00 2001 From: Chris McDonough Date: Sun, 28 Nov 2010 00:41:07 -0500 Subject: provide proper rendering example for methods and attributes --- docs/conventions.rst | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) (limited to 'docs/conventions.rst') diff --git a/docs/conventions.rst b/docs/conventions.rst index a764a372a..d72660921 100644 --- a/docs/conventions.rst +++ b/docs/conventions.rst @@ -22,12 +22,12 @@ concept are presented in the following style: We present Python method names using the following style: - :meth:`Python.method_name` + :meth:`pyramid.configuration.Configurator.add_view` We present Python class names, module names, attributes and global variables using the following style: - :class:`Python.class_module_or_attribute.name` + :class:`pyramid.configuration.Configurator.registry` References to glossary terms are presented using the following style: -- cgit v1.2.3 From 12205feb19ff908a7e7d72368b8e4d113bf2ed4e Mon Sep 17 00:00:00 2001 From: Chris McDonough Date: Sun, 28 Nov 2010 00:42:23 -0500 Subject: collapse python and xml code block example --- docs/conventions.rst | 11 +---------- 1 file changed, 1 insertion(+), 10 deletions(-) (limited to 'docs/conventions.rst') diff --git a/docs/conventions.rst b/docs/conventions.rst index d72660921..a17af7230 100644 --- a/docs/conventions.rst +++ b/docs/conventions.rst @@ -42,7 +42,7 @@ style: :ref:`traversal_chapter` -Python code blocks are presented in the following style: +Code and configuration file blocks are presented in the following style: .. code-block:: python :linenos: @@ -50,15 +50,6 @@ Python code blocks are presented in the following style: def foo(abc): pass -Blocks of XML markup are presented in the following style: - - .. code-block:: xml - :linenos: - - - - - When a command that should be typed on one line is too long to fit on a page, the backslash ``\`` is used to indicate that the following printed line should actually be part of the command: -- cgit v1.2.3