feedc0de/esp-idf
1
0
Fork 0
forked from espressif/esp-idf
Code Pull Requests Activity

Typo corrections

Browse Source
This commit is contained in:
Krzysztof
2016-10-30 19:54:10 +01:00
committed by Ivan Grokhotkov
parent d66f05c61b
commit 73944e6800
1 changed files with 5 additions and 5 deletions
Download Patch File Download Diff File Expand all files Collapse all files

6
docs/documenting-code.rst
View File

@@ -35,7 +35,7 @@ When writing code for this repository, please follow guidelines below.
1. Document all building blocks of code: functions, structs, typedefs, enums, macros, etc. Provide enough information on purpose, functionality and limitations of documented items, as you would like to see them documented when reading the code by others. 1. Document all building blocks of code: functions, structs, typedefs, enums, macros, etc. Provide enough information on purpose, functionality and limitations of documented items, as you would like to see them documented when reading the code by others.
2. Documentation of function should describe what this function does. If it accepts input parameters and returns some value, all they should be explained. 2. Documentation of function should describe what this function does. If it accepts input parameters and returns some value, all of them should be explained.
3. Do not add a data type before parameter or any other characters besides spaces. All spaces and line breaks are compressed into a single space. If you like to break a line, then break it twice. 3. Do not add a data type before parameter or any other characters besides spaces. All spaces and line breaks are compressed into a single space. If you like to break a line, then break it twice.
@@ -76,7 +76,7 @@ When writing code for this repository, please follow guidelines below.
Go one extra mile Go one extra mile
----------------- -----------------
There are are couple of tips how you can make your documentation even better and more useful to the reader. There are couple of tips how you can make your documentation even better and more useful to the reader.
Add code snippets to illustrate implementation. To do so, enclose the snippet using ``@code{c}`` and ``@endcode`` commands. Add code snippets to illustrate implementation. To do so, enclose the snippet using ``@code{c}`` and ``@endcode`` commands.
@@ -122,5 +122,5 @@ Wrap up
------- -------
We love good code that is doing cool things. We love good code that is doing cool things.
We love it even better, if it is well documented, so we can qickly make it run and also do the cool things. We love it even better, if it is well documented, so we can quickly make it run and also do the cool things.