blob: 23c0017b614148e35944f7e2f4d16d3146edae86 (
plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
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>
|
