openstack/openstack-manuals
Code Issues Proposed changes

[contributor] Add note about command example

Browse Source 
To reduce a scatter, standardize the command example notation.
Also, the standard simplifies description.

Related discussion at mailing list:
http://lists.openstack.org/pipermail/openstack-docs/2015-December/008124.html

Change-Id: I5968564539f2345c523b629d3b970f3c12b8718b
This commit is contained in:
KATO Tomoyuki 2016-01-01 10:48:05 +09:00
parent 64031f5e79
commit 5772d6c50f
1 changed files with 6 additions and 0 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

6
doc/contributor-guide/source/rst-conv/source-code.rst
View File

@ -90,6 +90,12 @@ files, ``console`` for console inputs and outputs, and so on.
[DEFAULT] [DEFAULT]
# List of directories to load filter definitions from (separated by ','). # List of directories to load filter definitions from (separated by ',').
.. note::
When you write the command example, you should write the input and output
as it is from the console in one code block, not add an extra blank line,
not split them into input block and output block.
You can omit the output where appropriate.
.. _remote-block: .. _remote-block: