Skip to content

Commit 4034933

Browse files
committed
[Docs] PR review and minor typos and grammar fixes
1 parent 468c0f6 commit 4034933

File tree

1 file changed

+16
-14
lines changed

1 file changed

+16
-14
lines changed

docs/source/guides/docs_contributing.rst

Lines changed: 16 additions & 14 deletions
Original file line numberDiff line numberDiff line change
@@ -116,7 +116,7 @@ API
116116

117117
In this section, you will include all the documentation about drivers, libraries, and any other related to the core.
118118

119-
In this section we do not add general information. For more general information, we have sections for other related parts, like the FAQ, library builder, troubleshooting, etc.
119+
In this section, we do not add general information. For more general information, we have sections for other related parts, like the FAQ, library builder, troubleshooting, etc.
120120

121121
Boards
122122
******
@@ -126,7 +126,7 @@ Here is the place to add any special guide on the development boards, pin layout
126126
Common
127127
******
128128

129-
In this folder, you can add all common information used in several different places. This helps to maintain the documentation easily maintainable.
129+
In this folder, you can add all common information used in several different places. This helps to make documentation easily maintainable.
130130

131131

132132
Guides
@@ -137,7 +137,7 @@ This is the place to add the guides for common applications, IDEs configuration,
137137
Tutorials
138138
*********
139139

140-
If you want to add a specific tutorial related to the Arduino for ESP32, this is the place. The intention is not to create a blog or a demo area, but this can be used to add some complex description or to add some more information about APIs.
140+
If you want to add a specific tutorial related to the Arduino core for ESP32, this is the place. The intention is not to create a blog or a demo area, but this can be used to add some complex description or to add some more information about APIs.
141141

142142
Images and Assets
143143
*****************
@@ -170,10 +170,10 @@ In this section, you need to add a brief description of the API. If you are desc
170170
API Functions
171171
^^^^^^^^^^^^^
172172

173-
To add a new function description, you must have in mind that the users only have access to the public functions.
173+
To add a new function description, you must know that the users only have access to the public functions.
174174

175175

176-
Here is an example on how to add the function description from `I2C API <https://docs.espressif.com/projects/arduino-esp32/en/latest/api/i2c.html>`_:
176+
Here is an example of how to add the function description from `I2C API <https://docs.espressif.com/projects/arduino-esp32/en/latest/api/i2c.html>`_:
177177

178178
.. code-block::
179179
@@ -202,12 +202,12 @@ Here is an example on how to add the function description from `I2C API <https:/
202202
203203
Be sure to include a very comprehensive description, add all the parameters in and out, and describe the desired output.
204204

205-
If the function use a spacific structure, you can also describe the structure in the same function block or add a specific section if the structure is shared with other functions.
205+
If the function uses a specific structure, you can also describe the structure in the same function block or add a specific section if the structure is shared with other functions.
206206

207207
Basic Usage
208208
^^^^^^^^^^^
209209

210-
Some APIs are more complex to use or require more steps in order to configure or initialize. If the API is not straight forward in terms of usalibilty, plese consider adding a how to use section, describing all the steps to get the API configured.
210+
Some APIs are more complex to use or require more steps in order to configure or initialize. If the API is not straightforward in terms of usability, please consider adding a how-to-use section describing all the steps to get the API configured.
211211

212212
Here is an example:
213213

@@ -216,13 +216,13 @@ Here is an example:
216216
Basic Usage
217217
^^^^^^^^^^^
218218
219-
To start using I2C as slave mode on the Arduino, the first step is to include the ``Wire.h`` header to the scketch.
219+
To start using I2C as slave mode on the Arduino, the first step is to include the ``Wire.h`` header to the sketch.
220220
221221
.. code-block:: arduino
222222
223223
#include "Wire.h"
224224
225-
Before calling ``begin`` we must create two callback functions to handle the communication with the master device.
225+
Before calling ``begin``, you must create two callback functions to handle the communication with the master device.
226226
227227
.. code-block:: arduino
228228
@@ -234,15 +234,15 @@ Here is an example:
234234
235235
Wire.onRequest(onRequest);
236236
237-
The ``onReceive`` will handle the request from the master device uppon a slave read request and the ``onRequest`` will handle the answer to the master.
237+
The ``onReceive`` will handle the request from the ``master`` device upon a slave read request and the ``onRequest`` will handle the answer to the master.
238238
239239
Now, we can start the peripheral configuration by calling ``begin`` function with the device address.
240240
241241
.. code-block:: arduino
242242
243243
Wire.begin((uint8_t)I2C_DEV_ADDR);
244244
245-
By using ``begin`` without any arguments, all the settings will be done by using the default values. To set the values by your own, see the function description. This function is described here: `i2c begin`_
245+
By using ``begin`` without any arguments, all the settings will be done by using the default values. To set the values on your own, see the function description. This function is described here: `i2c begin`_
246246
247247
248248
@@ -284,15 +284,17 @@ To add a code block, you can use the following structure:
284284
Links
285285
*****
286286

287-
To include links to external content, you can use two ways. The first
287+
To include links to external content, you can use two ways.
288+
289+
* First option:
288290

289291
.. code-block::
290292
291293
`Arduino Wire Library`_
292294
293295
_Arduino Wire Library: https://www.arduino.cc/en/reference/wire
294296
295-
or
297+
* Second option:
296298

297299
.. code-block::
298300
@@ -319,7 +321,7 @@ Be sure the file size does not exceed 600kB.
319321
Support
320322
*******
321323

322-
If you need support on the documentation, you can ask a question as a discussion `here <https://github.com/espressif/arduino-esp32/discussions>`_.
324+
If you need support on the documentation, you can ask a question in the discussion `here <https://github.com/espressif/arduino-esp32/discussions>`_.
323325

324326
Additional Guidelines
325327
---------------------

0 commit comments

Comments
 (0)
pFad - Phonifier reborn

Pfad - The Proxy pFad of © 2024 Garber Painting. All rights reserved.

Note: This service is not intended for secure transactions such as banking, social media, email, or purchasing. Use at your own risk. We assume no liability whatsoever for broken pages.


Alternative Proxies:

Alternative Proxy

pFad Proxy

pFad v3 Proxy

pFad v4 Proxy