summaryrefslogtreecommitdiff
path: root/docs/conventions.rst
diff options
context:
space:
mode:
authorSteve Piercy <web@stevepiercy.com>2015-05-28 02:24:29 -0700
committerSteve Piercy <web@stevepiercy.com>2015-05-28 02:24:29 -0700
commit0dcc49bda34968c42e129ed60da10bfdfda33303 (patch)
treef2e3e75ae40af8556dd251c125b05ce49b49aa01 /docs/conventions.rst
parent6e0f02a1e2d6fdece760f5ce1e61850b9514897d (diff)
parentc1677348ad92a7998ae1163c3e2f7b38942849c2 (diff)
downloadpyramid-0dcc49bda34968c42e129ed60da10bfdfda33303.tar.gz
pyramid-0dcc49bda34968c42e129ed60da10bfdfda33303.tar.bz2
pyramid-0dcc49bda34968c42e129ed60da10bfdfda33303.zip
Merge pull request #1803 from stevepiercy/master
grammar, punctuation
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.