alex/esp-idf
alex/esp-idf
1
0
Fork 0
mirror of https://github.com/espressif/esp-idf.git synced 2024-10-05 20:47:46 -04:00
Code Issues Actions 2 Packages Projects Releases Wiki Activity

docs: document contained an invalid character which couldnt be rendered in the PDF

Browse Source
This commit is contained in:
Marius Vikhammer 2021-06-01 09:34:52 +08:00
parent 0e68c222ac
commit c7ead8cd73
1 changed files with 1 additions and 1 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

2
docs/zh_CN/contribute/documenting-code.rst
View File

@ -142,7 +142,7 @@ Doxygen 支持多种排版风格，对于文档中可以包含的细节非常灵
对于 Markdown (.md) 或 reST (.rst) 文档中的文本类信息，请遵守下列规范保证文档格式统一。
1. 请确保一个段落仅有一行，同段落中不用断行，如下图所示。通过断行来提高可读性的准则仅限用于书写代码。对于文本类信息，可以通过添加空白行来增加段落，从而提高可读性。
1. 请确保一个段落仅有一行，同段落中不用断行，如下图所示。通过断行来提高可读性的准则仅限用于书写代码。对于文本类信息，可以通过添加空白行来增加段落，从而提高可读性。
.. figure:: ../../_static/doc-format1-recommend.png
:align: center