diff options
| author | Chris McDonough <chrism@plope.com> | 2012-03-19 00:06:48 -0400 |
|---|---|---|
| committer | Chris McDonough <chrism@plope.com> | 2012-03-19 00:06:48 -0400 |
| commit | 545654d60719161bdde4633afa42704cd5fedde5 (patch) | |
| tree | 7af89e4ad540782cdb3679d04600d0050946264d /docs/conventions.rst | |
| parent | 7b55442a0947663f3f1e76a504a9cb33d8d53086 (diff) | |
| download | pyramid-545654d60719161bdde4633afa42704cd5fedde5.tar.gz pyramid-545654d60719161bdde4633afa42704cd5fedde5.tar.bz2 pyramid-545654d60719161bdde4633afa42704cd5fedde5.zip | |
explain where things might go in reality and explain gt example Windows convention
Diffstat (limited to 'docs/conventions.rst')
| -rw-r--r-- | docs/conventions.rst | 27 |
1 files changed, 24 insertions, 3 deletions
diff --git a/docs/conventions.rst b/docs/conventions.rst index 9e8510e4d..0c38e11d8 100644 --- a/docs/conventions.rst +++ b/docs/conventions.rst @@ -50,9 +50,30 @@ Code and configuration file blocks are presented in the following style: def foo(abc): pass -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: +Example blocks representing UNIX shell commands are prefixed with a ``$`` +character, e.g.: + + .. code-block:: text + + $ ../bin/nosetests + +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 + +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 + +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: .. code-block:: text |
