michaelh/zephyr
1
0
Fork 0
Code Releases Activity

doc: Edit the code-block ReST documentation.

Browse source 
Change-Id: I4e38d9ed3cfb0aa50d559a94641c10175142f659
Signed-off-by: Rodrigo Caballero <rodrigo.caballero.abraham@intel.com>
This commit is contained in:
Rodrigo Caballero 2016-02-10 14:35:41 -06:00 • committed by Gerrit Code Review
commit 9a1acd715a
1 changed files with 5 additions and 6 deletions
Download patch file Download diff file Expand all files Collapse all files

11
doc/collaboration/documentation/code_blocks.rst
View file

@ -8,17 +8,16 @@ documentation must include code examples. The code examples can be
written directly in the documentation or included from a source file.
Use these guidelines to insert code blocks to your documentation:
* Include code examples from a source file . Only write the code
example directly into the documentation if the example is less than 10
* Include code examples from a source file. Only write the code
example directly into the documentation if the example is fewer than 10
lines long or not part of the code base of the Zephyr Kernel.
* Use the ``:lineos:`` option of the directives to add line numbers to
your example if it is larger than 12 lines.
* Specify the programing language of your example. Not only will it
add syntax highlighting but it also allows the reader to identify code
efficiently. Use bash for console commands, asm for assembly code and
c for C code.
* Specify the programming language of your example. It will add syntax
highlighting, and also allows the reader to identify code efficiently. Use
bash for console commands, asm for assembly code and c for C code.
* Treat all console commands that a user must use as code examples.