From 5772d6c50f9ea1a6493e71ec74538ee0574ecc59 Mon Sep 17 00:00:00 2001 From: KATO Tomoyuki Date: Fri, 1 Jan 2016 10:48:05 +0900 Subject: [PATCH] [contributor] Add note about command example 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 --- doc/contributor-guide/source/rst-conv/source-code.rst | 6 ++++++ 1 file changed, 6 insertions(+) diff --git a/doc/contributor-guide/source/rst-conv/source-code.rst b/doc/contributor-guide/source/rst-conv/source-code.rst index ac3962e74d..e893d8123a 100644 --- a/doc/contributor-guide/source/rst-conv/source-code.rst +++ b/doc/contributor-guide/source/rst-conv/source-code.rst @@ -90,6 +90,12 @@ files, ``console`` for console inputs and outputs, and so on. [DEFAULT] # 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: