summaryrefslogtreecommitdiff
path: root/docs/conventions.rst
diff options
context:
space:
mode:
authorTshepang Lekhonkhobe <tshepang@gmail.com>2013-03-13 23:05:17 +0200
committerTshepang Lekhonkhobe <tshepang@gmail.com>2013-03-13 23:05:17 +0200
commitf73f0e332658fac2583f51247dcd49bd36d63ce4 (patch)
tree9fcc88c1d361fbc417e78815db59e3a4ed8d3af7 /docs/conventions.rst
parent6d62d124ee8ffd09459690e34aae95b43d0f2d53 (diff)
downloadpyramid-f73f0e332658fac2583f51247dcd49bd36d63ce4.tar.gz
pyramid-f73f0e332658fac2583f51247dcd49bd36d63ce4.tar.bz2
pyramid-f73f0e332658fac2583f51247dcd49bd36d63ce4.zip
consistency: use $VENV whenever virtualenv binaries are used
Diffstat (limited to 'docs/conventions.rst')
-rw-r--r--docs/conventions.rst12
1 files changed, 8 insertions, 4 deletions
diff --git a/docs/conventions.rst b/docs/conventions.rst
index 0c38e11d8..4cffd1084 100644
--- a/docs/conventions.rst
+++ b/docs/conventions.rst
@@ -55,21 +55,25 @@ character, e.g.:
.. code-block:: text
- $ ../bin/nosetests
+ $ $VENV/bin/nosetests
+
+(See :term:`virtualenv` 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
- c:\examples> ..\Scripts\nosetests
+ c:\examples> %VENV%\Scripts\nosetests
+
+(See :term:`virtualenv` 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
- > ..\Scripts\nosetests
+ > %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
@@ -77,7 +81,7 @@ should actually be part of the command:
.. code-block:: text
- c:\bigfntut\tutorial> ..\Scripts\nosetests --cover-package=tutorial \
+ c:\bigfntut\tutorial> %VENV%\Scripts\nosetests --cover-package=tutorial \
--cover-erase --with-coverage
A sidebar, which presents a concept tangentially related to content