Text correction of timer.rst #8074
Merged
+15
−3
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Changed text because of an inconsistence between title and text explaining the timerGetConfig function. I don't know if the method timerSetConfig really exists.
|
|
P-R-O-C-H-Y
approved these changes
Apr 14, 2023
There was a problem hiding this comment.
Hi @renanrms, the function timerSetConfig exists, but this part of docs was supposed to be for timerGetConfig as your proposed changes :).
P-R-O-C-H-Y
requested changes
Apr 14, 2023
There was a problem hiding this comment.
@renanrms Can you please add the timerSetConfig too?
I have prepared the code for you.
timerSetConfig
**************
This function is used to configure initialized timer (timerBegin() called).
.. code-block:: arduino
void timerSetConfig(hw_timer_t *timer, uint32_t config);
* ``timer`` timer struct.
* ``config`` configuration as uint32_t number. Use configuration struct ``timer_cfg_t`` and pass ``timer_cfg_t.val`` as ``config`` paramater.
P-R-O-C-H-Y
added
the
Type: Documentation
Add informations about timerSetConfig function.
|
Hi @renanrms, |
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Changed text because of an inconsistence between title and text explaining the timerGetConfig function. I don't know if the method timerSetConfig really exists.
By completing this PR sufficiently, you help us to review this Pull Request quicker and also help improve the quality of Release Notes
Checklist
This entire section above can be deleted if all items are checked.
Description of Change
Please describe your proposed Pull Request and it's impact.
Tests scenarios
Please describe on what Hardware and Software combinations you have tested this Pull Request and how.
(eg. I have tested my Pull Request on Arduino-esp32 core v2.0.2 with ESP32 and ESP32-S2 Board with this scenario)
Related links
Please provide links to related issue, PRs etc.
(eg. Closes #number of issue)