summaryrefslogtreecommitdiff
path: root/docs/conventions.rst
diff options
context:
space:
mode:
authorCasey Duncan <casey.duncan@gmail.com>2010-11-30 19:46:45 -0700
committerCasey Duncan <casey.duncan@gmail.com>2010-11-30 19:46:45 -0700
commit031d9f20baee7f57534a805809ac6a11319330ce (patch)
tree9ab03b9fca24b5542441649eecf287f9e9f48e92 /docs/conventions.rst
parent3f0f1a7c9e0177352023bbe67b1eddf9185d759a (diff)
parent5238ae329fb70e5e386db0b127d958c8523d7247 (diff)
downloadpyramid-031d9f20baee7f57534a805809ac6a11319330ce.tar.gz
pyramid-031d9f20baee7f57534a805809ac6a11319330ce.tar.bz2
pyramid-031d9f20baee7f57534a805809ac6a11319330ce.zip
Merge https://github.com/Pylons/pyramid
Diffstat (limited to 'docs/conventions.rst')
-rw-r--r--docs/conventions.rst15
1 files changed, 3 insertions, 12 deletions
diff --git a/docs/conventions.rst b/docs/conventions.rst
index a764a372a..a17af7230 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:
@@ -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:
-
- <root>
- <!-- ... more XML .. -->
- </root>
-
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: