From 82aa0f3bc392d55558b7158ef832ec5b1885953d Mon Sep 17 00:00:00 2001 From: Alex Offshore Date: Thu, 9 Nov 2023 11:56:25 +0300 Subject: [PATCH] Minor fix style-guide.rst --- docs/en/contribute/style-guide.rst | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docs/en/contribute/style-guide.rst b/docs/en/contribute/style-guide.rst index 4e48b5d88d..3259b4576c 100644 --- a/docs/en/contribute/style-guide.rst +++ b/docs/en/contribute/style-guide.rst @@ -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.