Skip to content

Commit 592d0bf

Browse files
Apply changes from code review by @lucasssvaz
Co-authored-by: Lucas Saavedra Vaz <[email protected]>
1 parent b6368b4 commit 592d0bf

File tree

3 files changed

+36
-36
lines changed

3 files changed

+36
-36
lines changed

Diff for: docs/source/api/ledc.rst

+2-2
Original file line numberDiff line numberDiff line change
@@ -130,8 +130,8 @@ This function is used to detach the pin from LEDC.
130130
131131
* ``pin`` select LEDC pin.
132132

133-
This function will return ``true`` if detaching is successful.
134-
If ``false`` is returned, error occurs and pin is not detached.
133+
This function returns ``true`` if detaching was successful.
134+
If ``false`` is returned, an error occurred and the pin was not detached.
135135

136136
ledcChangeFrequency
137137
*******************

Diff for: docs/source/api/sigmadelta.rst

+9-9
Original file line numberDiff line numberDiff line change
@@ -26,7 +26,7 @@ Arduino-ESP32 SigmaDelta API
2626
sigmaDeltaAttach
2727
****************
2828

29-
This function is used to setup the SigmaDelta channel with selected frequency and attach it to selected pin.
29+
This function is used to set up the SigmaDelta channel with the selected frequency and attach it to the selected pin.
3030

3131
.. code-block:: arduino
3232
@@ -37,8 +37,8 @@ This function is used to setup the SigmaDelta channel with selected frequency an
3737

3838
* range is 1-14 bits (1-20 bits for ESP32).
3939

40-
This function will return ``true`` if configuration is successful.
41-
If ``false`` is returned, error occurs and the SigmaDelta channel was not configured.
40+
This function returns ``true`` if the configuration was successful.
41+
If ``false`` is returned, an error occurred and the SigmaDelta channel was not configured.
4242

4343
sigmaDeltaWrite
4444
***************
@@ -49,25 +49,25 @@ This function is used to set duty for the SigmaDelta pin.
4949
5050
bool sigmaDeltaWrite(uint8_t pin, uint8_t duty);
5151
52-
* ``pin`` select GPIO pin.
53-
* ``duty`` select duty to be set for selected pin.
52+
* ``pin`` selects the GPIO pin.
53+
* ``duty`` selects the duty to be set for selected pin.
5454

55-
This function will return ``true`` if setting duty is successful.
55+
This function returns ``true`` if setting the duty was successful.
5656
If ``false`` is returned, error occurs and duty was not set.
5757

5858
sigmaDeltaDetach
5959
****************
6060

61-
This function is used to detach pin from SigmaDelta and deinit the channel that was attached to the pin.
61+
This function is used to detach a pin from SigmaDelta and deinit the channel that was attached to the pin.
6262

6363
.. code-block:: arduino
6464
6565
bool sigmaDeltaDetach(uint8_t pin);
6666
6767
* ``pin`` select GPIO pin.
6868

69-
This function will return ``true`` if detaching is successful.
70-
If ``false`` is returned, error occurs and pin is not detached.
69+
This function returns ``true`` if detaching was successful.
70+
If ``false`` is returned, an error occurred and pin was not detached.
7171

7272
Example Applications
7373
********************

Diff for: docs/source/migration_guide/2.x_to_3.0.rst

+25-25
Original file line numberDiff line numberDiff line change
@@ -5,8 +5,8 @@ Migration from 2.x to 3.0
55
Introduction
66
------------
77

8-
This is a guide to show breaking changes in API and to help migrate projects from 2.X version to 3.0 version of Arduino ESP32 core.
9-
For more informations about all changes and new features check `RELESE NOTES <https://github.com/espressif/arduino-esp32/releases>`_.
8+
This is a guide to highlight breaking changes in the API and to help the migration of projects from versions 2.X to version 3.0 of the Arduino ESP32 core.
9+
For more information about the changes and new features, check `RELEASE NOTES <https://github.com/espressif/arduino-esp32/releases>`_.
1010

1111
ADC
1212
---
@@ -40,14 +40,14 @@ Removed APIs
4040
I2S
4141
---
4242

43-
I2S driver has beed completely redesigned and refactored to use new ESP-IDF driver.
44-
For more informations about the new API check `I2S API <https://docs.espressif.com/projects/arduino-esp32/en/latest/api/i2s.html>`_.
43+
The I2S driver has been completely redesigned and refactored to use the new ESP-IDF driver.
44+
For more information about the new API, check `I2S API <https://docs.espressif.com/projects/arduino-esp32/en/latest/api/i2s.html>`_.
4545

4646
LEDC
4747
----
4848

49-
LEDC API has been changed in order to support the Peripheral Manager and easier use as LEDC channels are now automaticaly assigned to pins.
50-
For more informations about the new API check `LEDC API <https://docs.espressif.com/projects/arduino-esp32/en/latest/api/ledc.html>`_.
49+
The LEDC API has been changed in order to support the Peripheral Manager and make it easier to use, as LEDC channels are now automatically assigned to pins.
50+
For more information about the new API, check `LEDC API <https://docs.espressif.com/projects/arduino-esp32/en/latest/api/ledc.html>`_.
5151

5252
Removed APIs
5353
************
@@ -58,21 +58,21 @@ Removed APIs
5858
New APIs
5959
********
6060

61-
* ``ledcAttach`` used to setup LEDC pin (merged ``ledcSetup`` and ``ledcAttachPin`` functions).
62-
* ``timerGetFrequency`` used to get actual frequency of the timer.
63-
* ``timerAttachInterruptArg`` used to attach interrupt to timer using argument.
61+
* ``ledcAttach`` used to set up the LEDC pin (merged ``ledcSetup`` and ``ledcAttachPin`` functions).
62+
* ``timerGetFrequency`` used to get the actual frequency of the timer.
63+
* ``timerAttachInterruptArg`` used to attach the interrupt to a timer using arguments.
6464

6565
Changes in APIs
6666
***************
6767

6868
* ``ledcDetachPin`` renamed to ``ledcDetach``.
69-
* In all functions input parameter ``channel`` have been changed to ``pin``.
69+
* In all functions, input parameter ``channel`` has been changed to ``pin``.
7070

7171
RMT
7272
---
7373

7474
TODO:
75-
For more informations about the new API check `RMT API <https://docs.espressif.com/projects/arduino-esp32/en/latest/api/rmt.html>`_.
75+
For more information about the new API, check `RMT API <https://docs.espressif.com/projects/arduino-esp32/en/latest/api/rmt.html>`_.
7676

7777
Removed APIs
7878
************
@@ -92,8 +92,8 @@ TODO:
9292
SigmaDelta
9393
----------
9494

95-
SigmaDelta has been refactored to use new ESP-IDF driver.
96-
For more informations about the new API check `SigmaDelta API <https://docs.espressif.com/projects/arduino-esp32/en/latest/api/sigmadelta.html>`_.
95+
SigmaDelta has been refactored to use the new ESP-IDF driver.
96+
For more information about the new API, check `SigmaDelta API <https://docs.espressif.com/projects/arduino-esp32/en/latest/api/sigmadelta.html>`_.
9797

9898
Removed APIs
9999
************
@@ -104,20 +104,20 @@ Removed APIs
104104
New APIs
105105
********
106106

107-
* ``sigmaDeltaAttach`` used to setup SigmaDelta pin (channel is aquired automatically).
108-
* ``timerGetFrequency`` used to get actual frequency of the timer.
109-
* ``timerAttachInterruptArg`` used to attach interrupt to timer using argument.
107+
* ``sigmaDeltaAttach`` used to set up the SigmaDelta pin (channel is acquired automatically).
108+
* ``timerGetFrequency`` used to get the actual frequency of the timer.
109+
* ``timerAttachInterruptArg`` used to attach the interrupt to a timer using arguments.
110110

111111
Changes in APIs
112112
***************
113113

114114
* ``sigmaDeltaDetachPin`` renamed to ``sigmaDeltaDetach``.
115-
* ``sigmaDeltaWrite`` input parameter ``channel`` have been changed to ``pin``.
115+
* ``sigmaDeltaWrite`` input parameter ``channel`` has been changed to ``pin``.
116116

117117
Timer
118118
-----
119119

120-
Timer has been refactored to use new ESP-IDF driver and its API got simplified. For more informations about the new API check
120+
Timer has been refactored to use the new ESP-IDF driver and its API got simplified. For more information about the new API check
121121
`TIMER API <https://docs.espressif.com/projects/arduino-esp32/en/latest/api/timer.html>`_.
122122

123123
Removed APIs
@@ -143,22 +143,22 @@ Removed APIs
143143
New APIs
144144
********
145145

146-
* ``timerAlarm`` used to setup Alarm for timer and enables it automaticaly (merged ``timerAlarmWrite`` and ``timerAlarmEnable`` functions).
147-
* ``timerGetFrequency`` used to get actual frequency of the timer.
148-
* ``timerAttachInterruptArg`` used to attach interrupt to timer using argument.
146+
* ``timerAlarm`` used to set up Alarm for the timer and enable it automatically (merged ``timerAlarmWrite`` and ``timerAlarmEnable`` functions).
147+
* ``timerGetFrequency`` used to get the actual frequency of the timer.
148+
* ``timerAttachInterruptArg`` used to attach the interrupt to a timer using arguments.
149149

150150
Changes in APIs
151151
***************
152152

153-
* ``timerBegin`` now have only 1 parameter wich is frequency. There is an automatic calculation of divider through different clock sources¨
154-
to achieve selected frequency.
155-
* ``timerAttachInterrupt`` now have only 2 parameters -> parameter ``edge`` has been removed.
153+
* ``timerBegin`` has now only 1 parameter (frequency). There is an automatic calculation of the divider using different clock sources
154+
to achieve the selected frequency.
155+
* ``timerAttachInterrupt`` has now only 2 parameters. The ``edge`` parameter has been removed.
156156

157157
UART
158158
----
159159

160160
TODO:
161-
For more informations about the new API check `UART API <https://docs.espressif.com/projects/arduino-esp32/en/latest/api/rmt.html>`_.
161+
For more information about the new API, check `UART API <https://docs.espressif.com/projects/arduino-esp32/en/latest/api/rmt.html>`_.
162162

163163
Removed APIs
164164
************

0 commit comments

Comments
 (0)