summaryrefslogtreecommitdiff
path: root/docs/conventions.rst
diff options
context:
space:
mode:
authorChris McDonough <chrism@plope.com>2015-06-05 14:06:02 -0400
committerChris McDonough <chrism@plope.com>2015-06-05 14:06:02 -0400
commitf3c67a4217504bc7f2862ec1616342240738efae (patch)
tree9e7452b3ffdc8d4f30739cfc9d898169d6719206 /docs/conventions.rst
parent7b4ed3088af03de473ad164c314062c283afce39 (diff)
parentc1dbb5092d486df5d7fbad8e52cd1dbcc2c834d9 (diff)
downloadpyramid-f3c67a4217504bc7f2862ec1616342240738efae.tar.gz
pyramid-f3c67a4217504bc7f2862ec1616342240738efae.tar.bz2
pyramid-f3c67a4217504bc7f2862ec1616342240738efae.zip
Merge branch 'master' of github.com:Pylons/pyramid
Diffstat (limited to 'docs/conventions.rst')
-rw-r--r--docs/conventions.rst8
1 files changed, 4 insertions, 4 deletions
diff --git a/docs/conventions.rst b/docs/conventions.rst
index 21b506623..0492ab4fd 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::
@@ -105,7 +105,7 @@ 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.