diff options
| author | Bert JW Regeer <bertjw@regeer.org> | 2015-10-20 23:19:18 -0600 |
|---|---|---|
| committer | Bert JW Regeer <bertjw@regeer.org> | 2015-10-20 23:19:18 -0600 |
| commit | 18e54fe9619fd8b2aa6006126fc1c2840e32f2c1 (patch) | |
| tree | ea26bbfd681ae5d821f2cde9ac5cbe2e80f5c714 /docs/conventions.rst | |
| parent | bf40a3920278b3e7a01ef5403196b35f45cfcb3c (diff) | |
| parent | d4221720b8409eafb65b301562be327af0196c7e (diff) | |
| download | pyramid-18e54fe9619fd8b2aa6006126fc1c2840e32f2c1.tar.gz pyramid-18e54fe9619fd8b2aa6006126fc1c2840e32f2c1.tar.bz2 pyramid-18e54fe9619fd8b2aa6006126fc1c2840e32f2c1.zip | |
Merge branch 'master' of github.com:Pylons/pyramid into feature/configurable-view-deriver
Diffstat (limited to 'docs/conventions.rst')
| -rw-r--r-- | docs/conventions.rst | 12 |
1 files changed, 6 insertions, 6 deletions
diff --git a/docs/conventions.rst b/docs/conventions.rst index 21b506623..a9d2550bf 100644 --- a/docs/conventions.rst +++ b/docs/conventions.rst @@ -1,19 +1,19 @@ Typographical Conventions ========================= -Literals, filenames and function arguments are presented using the +Literals, filenames, and function arguments are presented using the following style: ``argument1`` -Warnings, which represent limitations and need-to-know information +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 +Notes which represent additional information related to a topic or concept are presented in the following style: .. note:: @@ -24,7 +24,7 @@ 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 +We present Python class names, module names, attributes, and global variables using the following style: :class:`pyramid.config.Configurator.registry` @@ -105,10 +105,10 @@ 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). + 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/removing imported objects from the package is quicker and results +* Adding or removing imported objects from the package is quicker and results in simpler diffs. |