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
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
|
.. _style_guide:
Style 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 method names using the following style:
:meth:`pyramid.config.Configurator.add_view`
We present Python class names, module names, attributes, and global
variables using the following style:
:class:`pyramid.config.Configurator.registry`
References to glossary terms are presented using the following style:
:term:`Pylons`
URLs are presented using the following style:
`Pylons <http://www.pylonsproject.org>`_
References to sections and chapters are presented using the following
style:
:ref:`traversal_chapter`
Code and configuration file blocks are presented in the following style:
.. code-block:: python
:linenos:
def foo(abc):
pass
Example blocks representing UNIX shell commands are prefixed with a ``$``
character, e.g.:
.. code-block:: bash
$ $VENV/bin/py.test -q
See :term:`venv` for the meaning of ``$VENV``.
Example blocks representing Windows commands are prefixed with a drive letter
with an optional directory name, e.g.:
.. code-block:: doscon
c:\examples> %VENV%\Scripts\py.test -q
See :term:`venv` for the meaning of ``%VENV%``.
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
be part of the command:
.. code-block:: bash
$VENV/bin/py.test tutorial/tests.py --cov-report term-missing \
--cov=tutorial -q
A sidebar, which presents a concept tangentially related to content discussed
on a page, is rendered like so:
.. sidebar:: This is a sidebar
Sidebar information.
When multiple objects are imported from the same package, the following
convention is used:
.. code-block:: python
from foo import (
bar,
baz,
)
It may look unusual, but it has advantages:
* It allows one to swap out the higher-level package ``foo`` for something else
that provides the similar API. An example would be swapping out one database
for another (e.g., graduating from SQLite to PostgreSQL).
* Looks more neat in cases where a large number of objects get imported from
that package.
* Adding or removing imported objects from the package is quicker and results
in simpler diffs.
|
