summaryrefslogtreecommitdiff
path: root/docs/typographical-conventions.rst
diff options
context:
space:
mode:
authorMichael Merickel <github@m.merickel.org>2018-08-21 01:44:55 -0500
committerGitHub <noreply@github.com>2018-08-21 01:44:55 -0500
commit820a752645b460ea8009b07a75c752ab09c53dec (patch)
tree14616d81a7abedfe523c057e71ed7b2aca680754 /docs/typographical-conventions.rst
parentdf8598a2658632f709a64e8076cce02ca49de8e6 (diff)
parent254710cb716dccfe536b20d077e3cb79be19c6b3 (diff)
downloadpyramid-820a752645b460ea8009b07a75c752ab09c53dec.tar.gz
pyramid-820a752645b460ea8009b07a75c752ab09c53dec.tar.bz2
pyramid-820a752645b460ea8009b07a75c752ab09c53dec.zip
Merge pull request #3330 from stevepiercy/docs-code-style
Docs code style
Diffstat (limited to 'docs/typographical-conventions.rst')
-rw-r--r--docs/typographical-conventions.rst10
1 files changed, 5 insertions, 5 deletions
diff --git a/docs/typographical-conventions.rst b/docs/typographical-conventions.rst
index 2bfe4ffa6..76fdf8ace 100644
--- a/docs/typographical-conventions.rst
+++ b/docs/typographical-conventions.rst
@@ -73,17 +73,17 @@ XML:
<somesnippet>Some XML</somesnippet>
-Unix shell commands are prefixed with a ``$`` character. (See :term:`venv` for the meaning of ``$VENV``.)
+Unix shell commands (See :term:`venv` for the meaning of ``$VENV``.):
.. code-block:: bash
- $ $VENV/bin/pip install -e .
+ $VENV/bin/pip install -e .
-Windows commands are prefixed with a drive letter with an optional directory name. (See :term:`venv` for the meaning of ``%VENV%``.)
+Windows commands (See :term:`venv` for the meaning of ``%VENV%``.):
.. code-block:: doscon
- c:\> %VENV%\Scripts\pserve development.ini
+ %VENV%\Scripts\pserve development.ini
cfg:
@@ -128,7 +128,7 @@ When a command that should be typed on one line is too long to fit on the displa
.. code-block:: bash
- $ $VENV/bin/py.test tutorial/tests.py --cov-report term-missing \
+ $VENV/bin/py.test tutorial/tests.py --cov-report term-missing \
--cov=tutorial -q