summaryrefslogtreecommitdiff
path: root/docs
diff options
context:
space:
mode:
authorSteve Piercy <web@stevepiercy.com>2016-04-16 14:10:14 -0700
committerSteve Piercy <web@stevepiercy.com>2016-04-16 14:10:14 -0700
commit1ceb14546a6f82b886f45c256379a2ef3897c6a5 (patch)
treec8a041dade650a1f3dab4a381c5f2b652fbb3d2e /docs
parent30884b15582b8612716eb43a76f0d5e84f54772c (diff)
downloadpyramid-1ceb14546a6f82b886f45c256379a2ef3897c6a5.tar.gz
pyramid-1ceb14546a6f82b886f45c256379a2ef3897c6a5.tar.bz2
pyramid-1ceb14546a6f82b886f45c256379a2ef3897c6a5.zip
replace nose with pytest, clean up
Diffstat (limited to 'docs')
-rw-r--r--docs/conventions.rst34
1 files changed, 17 insertions, 17 deletions
diff --git a/docs/conventions.rst b/docs/conventions.rst
index 0346f1107..5164b5479 100644
--- a/docs/conventions.rst
+++ b/docs/conventions.rst
@@ -53,46 +53,46 @@ Code and configuration file blocks are presented in the following style:
Example blocks representing UNIX shell commands are prefixed with a ``$``
character, e.g.:
- .. code-block:: text
+ .. code-block:: bash
- $ $VENV/bin/nosetests
+ $ $VENV/bin/py.test tutorial/tests.py -q
(See :term:`venv` for the meaning of ``$VENV``)
Example blocks representing Windows ``cmd.exe`` commands are prefixed with a
drive letter and/or a directory name, e.g.:
- .. code-block:: text
+ .. code-block:: doscon
- c:\examples> %VENV%\Scripts\nosetests
+ c:\examples> %VENV%\Scripts\py.test tutorial\tests.py -q
(See :term:`venv` for the meaning of ``%VENV%``)
Sometimes, when it's unknown which directory is current, Windows ``cmd.exe``
example block commands are prefixed only with a ``>`` character, e.g.:
- .. code-block:: text
+ .. code-block:: doscon
> %VENV%\Scripts\nosetests
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 actually be part of the command:
+the backslash ``\`` is used to indicate that the following printed line should
+be part of the command:
- .. code-block:: text
+ .. code-block:: bash
- c:\bigfntut\tutorial> %VENV%\Scripts\nosetests --cover-package=tutorial \
- --cover-erase --with-coverage
+ $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:
+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:
+When multiple objects are imported from the same package, the following
+convention is used:
.. code-block:: python
@@ -103,9 +103,9 @@ the following convention is used:
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).
+* 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.