Skip to content

Commit 5132d47

Browse files
committed
Fix docs
1 parent 0bd1a4c commit 5132d47

File tree

1 file changed

+7
-2
lines changed

1 file changed

+7
-2
lines changed

docs/en/contributing.rst

+7-2
Original file line numberDiff line numberDiff line change
@@ -124,6 +124,11 @@ Here is an example of the ``ci.json`` file where the example requires Wi-Fi to w
124124
]
125125
}
126126
127+
.. note::
128+
129+
The list of configurations will be checked against the ``sdkconfig`` file in the target folder. If the configuration is not present in the ``sdkconfig``,
130+
the test will be skipped for that target. That means that the test will only run on the targets that have **ALL** the required configurations.
131+
127132
Sometimes, the example might not be supported by some target, even if the target has the required configurations
128133
(like resources limitations or requiring a specific SoC). To avoid compilation errors, you can add the target to the ``ci.json``
129134
file so the CI system will force to skip the test on that target.
@@ -147,14 +152,14 @@ For example, in the sketch:
147152
.. code-block:: arduino
148153
149154
/*
150-
THIS FEATURE REQUIRES WI-FI SUPPORT AND IS NOT AVAILABLE FOR ESP32-S2
155+
THIS FEATURE REQUIRES WI-FI SUPPORT AND IS NOT AVAILABLE FOR ESP32-S2 AS IT DOES NOT HAVE ENOUGH RAM.
151156
*/
152157
153158
And in the ``README.md`` file:
154159

155160
.. code-block:: markdown
156161
157-
Currently, this example supports the following targets.
162+
Currently, this example requires Wi-Fi and supports the following targets.
158163
159164
| Supported Targets | ESP32 | ESP32-H2 | ESP32-S3 | ESP32-C3 | ESP32-C6 |
160165
| ----------------- | ----- | -------- | -------- | -------- | -------- |

0 commit comments

Comments
 (0)