diff options
Diffstat (limited to 'docs/conventions.rst')
| -rw-r--r-- | docs/conventions.rst | 63 |
1 files changed, 63 insertions, 0 deletions
diff --git a/docs/conventions.rst b/docs/conventions.rst new file mode 100644 index 000000000..23c0017b6 --- /dev/null +++ b/docs/conventions.rst @@ -0,0 +1,63 @@ +Typographical Conventions +========================= + +The following typographical conventions are used within this guide. + +Literals, filenames and function arguments are presented using the +following style: + + ``argument1`` + +Warnings, which represent limitations and need-to-know information +related to a topic or concept are presented in the following style: + + .. warning:: + + This is a warning. + +Notes, which represent additional information related to a topic or +concept are presented in the following style: + +.. note:: + + This is a note. + +We present Python class names using the following style: + + :class:`Python.class.name` + +We present Python method names using the following style: + + :meth:`Python.method_name`. + +We present Python module names using the following style: + + :mod:`Python.module.name`. + +We present Python attributes and global variables using the following +style: + + :data:`Python.attribute`. + +References ot glossary terms and other document sections are presented +using the following style: + + :term:`Repoze`. + +Python code blocks are presented in the following style: + + .. code-block:: python + :linenos: + + def foo(abc): + pass + +Blocks of XML markup are presented in the following style: + + .. code-block:: xml + :linenos: + + <root> + <!-- ... more XML .. --> + </root> + |
