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

Merge branch 'contrib/github_pr_12551' into 'master'

Browse Source 
Minor fix style-guide.rst (GitHub PR)

Closes IDFGH-11413

See merge request espressif/esp-idf!27113
This commit is contained in:
Darian 2023-11-14 16:24:51 +08:00
commit 159beab9d9
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/en/contribute/style-guide.rst
View File

@ -239,7 +239,7 @@ The standard C ``assert()`` function, defined in ``assert.h`` should be used to
.. note::
When asserting a value of type ``esp_err_t``is equal to ``ESP_OK``, use the :ref:`esp-error-check-macro` instead of an ``assert()``.
When asserting a value of type ``esp_err_t`` is equal to ``ESP_OK``, use the :ref:`esp-error-check-macro` instead of an ``assert()``.
It is possible to configure ESP-IDF projects with assertions disabled (see :ref:`CONFIG_COMPILER_OPTIMIZATION_ASSERTION_LEVEL`). Therefore, functions called in an ``assert()`` statement should not have side-effects.