mirror
/
esp-idf
kopia lustrzana https://github.com/espressif/esp-idf
1
0
Forkuj 0
Kod Zgłoszenia Projekty Wydania Wiki Aktywność

Clarification on documenting examples

pull/191/head
Krzysztof 2016-12-27 12:32:40 +01:00
rodzic 835fa31d56
commit 6a39bc6996
1 zmienionych plików z 9 dodań i 4 usunięć
Pokaż statystyki Ściągnij plik aktualizacji Ściągnij plik porównania Expand all files Collapse all files

13
docs/api/template.rst
Wyświetl plik

@ -40,10 +40,15 @@ Application Example
*INSTRUCTIONS* *INSTRUCTIONS*
1. Provide one or more practical examples to demonstrate functionality of this API. 1. Prepare one or more practical examples to demonstrate functionality of this API.
2. Break down the code into parts and describe functionality of each part. 2. Each example should follow pattern of projects located in ``esp-idf/examples/`` folder.
3. Provide screenshots if applicable. 3. Place example in this folder complete with ``README.md`` file.
4. Provide overview of demonstrated functionality in ``README.md``.
5. With good overview reader should be able to understand what example does without opening the source code.
6. Depending on complexity of example, break down description of code into parts and provide overview of functionality of each part.
7. Include flow diagram and screenshots of application output if applicable.
8. Finally add in this section synopsis of each example together with link to respective folder in ``esp-idf/examples/``.
API Reference API Reference
------------- -------------