Requested changes for arduino/reference-en#750 #1
Conversation
This file contains hidden or 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
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.
|
I agree with your reasoning on the modifications. I'll be more wary of these shortcomings in the future, thanks for the suggestions. |
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.
Hi @AshutoshPandey123456. I have some changes to propose to your pull request arduino#750. Unfortunately, GitHub's review system isn't powerful enough to support this particular case, so I'm just submitting them as a PR to the branch of your fork. If you merge this, it will automatically update the PR.
Please see the commit messages of the individual commits for explanation of the requested changes.
I'm happy to discuss my proposed modifications, but it is definitely going to be necessary to modify your PR before it can be merged because it would break the documentation generation system in its current state.