Skip to content

Commit c2cdeb6

Browse files
committed
fix(docs): Apply suggestions
1 parent 740f8c4 commit c2cdeb6

File tree

1 file changed

+3
-3
lines changed

1 file changed

+3
-3
lines changed

docs/en/contributing.rst

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -290,7 +290,7 @@ The tests are divided into two categories inside the ``tests`` folder:
290290

291291
.. note::
292292

293-
Keep in mind that to run the CI scripts locally you need to have the Go-based ``yq`` from `mikefarah/yq <https://github.com/mikefarah/yq>`_
293+
Keep in mind that to run the CI scripts locally, you need to have the Go-based ``yq`` from `mikefarah/yq <https://github.com/mikefarah/yq>`_
294294
installed and not the Python-based ``yq`` from PyPI or `kislyuk/yq <https://github.com/kislyuk/yq>`_.
295295
The syntax is slightly different and will not work with the CI scripts.
296296
You can install the Go-based ``yq`` through ``brew``, ``chocolatey`` or downloading the binary directly from the `releases page <https://github.com/mikefarah/yq/releases>`_.
@@ -388,8 +388,8 @@ You can use the ``hello_world`` test suite as a starting point and the other tes
388388

389389
A test suite contains the following files:
390390

391-
* ``test_<test_name>.py``: The test file that contains the test cases. Required.
392-
* ``<test_name>.ino``: The sketch that will be tested. Required.
391+
* ``test_<test_name>.py``: Is the test file that contains the test cases. Required.
392+
* ``<test_name>.ino``: This is the sketch that will be tested. Required.
393393
* ``ci.yml``: The file that specifies how the test suite will be run in the CI system. Optional.
394394
* ``diagram.<target>.json``: The diagram file that specifies the connections between the components in Wokwi. Optional.
395395
* Any other files that are needed for the test suite.

0 commit comments

Comments
 (0)