Added Example Code/ Notes and warnings #750
Merged
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
There was no example code given, and the returns section was incorrect. The code was tested on Arduino Mega 2560.
The newly added content was placed inside the "See Also" section, which caused the generation process to fail: ERROR 2020/07/15 05:00:40 Language/Functions/Bits and Bytes/bitClear.adoc: asciidoctor: WARNING: <stdin>: line 69: section title out of sequence: expected level 1, got level 2 ERROR 2020/07/15 05:00:40 Language/Functions/Bits and Bytes/bitClear.adoc: asciidoctor: WARNING: <stdin>: line 71: unterminated open block
- Use the standard "Arduino sketch style" formatting. - Move the print to setup(), so it only happens once.
The zero-indexed nature of the macro is already documented in the parameters section. The handling of zeroed bits is already clear from the description. The requirement for the parameters to be integers seems fairly obvious to me, but I'm open to being convinced otherwise. However, if it is necessary to document the supported parameter types, that should be done in the parameters section, following the convention that has been established through the rest of the language reference content, so this part needs to be removed either way.
Requested changes for arduino#750
|
Thanks so much @AshutoshPandey123456! |
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.
There was no example code given, and the returns section was incorrect. The code was tested on Arduino Mega 2560.