Improve pulseInLong() description #371
Merged
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
Collaborator
per1234
commented
Jun 4, 2018
per1234
commented
- Explain difference between pulseIn() and pulseInLong().
- Improve the explanation of pulseInLong()'s pulse handling.
- Improve documentation of how pulseInLong()'s timeout works.
- Use consistent formatting in pulseInLong() description.
Likely the question "What's the difference between this and pulseIn()" will be the first thing a user will want to know when visiting this page. Although this information was somewhat alluded to at the end of the description, it's much better for it to be at the start of the text. Reference: arduino/Arduino#2495 (comment)
Previously there was an initial incomplete description of how pulses are handled, followed by a note clarifying how it actually works. Combining all the information into a single statement avoids confusion and makes the documentation less verbose.
Previously it was not clear that the function returns after the timeout expires.
Code markdown was used on some instances of the words HIGH and LOW and not on others. A search of the rest of the reference pages shows them to be quite inconsistent in formatting but code markdown is used in the majority of instances and I feel that's the correct usage.
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.