From 545654d60719161bdde4633afa42704cd5fedde5 Mon Sep 17 00:00:00 2001 From: Chris McDonough Date: Mon, 19 Mar 2012 00:06:48 -0400 Subject: explain where things might go in reality and explain gt example Windows convention --- docs/conventions.rst | 27 ++++++++++++++++++++++++--- 1 file changed, 24 insertions(+), 3 deletions(-) (limited to 'docs/conventions.rst') 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 -- cgit v1.2.3