You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: docs/source/guides/docs_contributing.rst
+16-14Lines changed: 16 additions & 14 deletions
Original file line number
Diff line number
Diff line change
@@ -116,7 +116,7 @@ API
116
116
117
117
In this section, you will include all the documentation about drivers, libraries, and any other related to the core.
118
118
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.
120
120
121
121
Boards
122
122
******
@@ -126,7 +126,7 @@ Here is the place to add any special guide on the development boards, pin layout
126
126
Common
127
127
******
128
128
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.
130
130
131
131
132
132
Guides
@@ -137,7 +137,7 @@ This is the place to add the guides for common applications, IDEs configuration,
137
137
Tutorials
138
138
*********
139
139
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.
141
141
142
142
Images and Assets
143
143
*****************
@@ -170,10 +170,10 @@ In this section, you need to add a brief description of the API. If you are desc
170
170
API Functions
171
171
^^^^^^^^^^^^^
172
172
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.
174
174
175
175
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>`_:
177
177
178
178
.. code-block::
179
179
@@ -202,12 +202,12 @@ Here is an example on how to add the function description from `I2C API <https:/
202
202
203
203
Be sure to include a very comprehensive description, add all the parameters in and out, and describe the desired output.
204
204
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.
206
206
207
207
Basic Usage
208
208
^^^^^^^^^^^
209
209
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.
211
211
212
212
Here is an example:
213
213
@@ -216,13 +216,13 @@ Here is an example:
216
216
Basic Usage
217
217
^^^^^^^^^^^
218
218
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.
220
220
221
221
.. code-block:: arduino
222
222
223
223
#include "Wire.h"
224
224
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.
226
226
227
227
.. code-block:: arduino
228
228
@@ -234,15 +234,15 @@ Here is an example:
234
234
235
235
Wire.onRequest(onRequest);
236
236
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.
238
238
239
239
Now, we can start the peripheral configuration by calling ``begin`` function with the device address.
240
240
241
241
.. code-block:: arduino
242
242
243
243
Wire.begin((uint8_t)I2C_DEV_ADDR);
244
244
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`_
246
246
247
247
248
248
@@ -284,15 +284,17 @@ To add a code block, you can use the following structure:
284
284
Links
285
285
*****
286
286
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.
0 commit comments