Minor edits to documentation and comments#433
Merged
Conversation
Fixed typo in documentation. Fixed minor spacing issues in documentation.
In documentation: fixed wrong word used, added "." to end of sentence, reworded a sentence for clarity. No code changed.
In documentation: changed "i.e." to "e.g.", reworked a sentence. No code changed.
Wrapped long lines in documentation at 80 characters
This reverts commit ebd5c48.
In documentation: wrapped several terms in "\code{}", improved formatting consistency for param descriptions. No code changes.
In comment: fixed typo ("nominator" -> "numerator"). In documentation: wrapped some terms in "\code{}". No code changed.
In documentation: corrected error about default `quiet` param value; cleaned up spacing around commas in sentences; split run-on into 2 sentences. No meaningful code changed (deleted some unnecessary whitespace).
Added comment to example for `as_units.difftime` method to separate from other unrelated examples in `make_units` help page. No functional code changed.
Member
|
Thanks! |
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
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
2 participants
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.
Made some minor edits (spacing, punctuation, rearranged a few sentences, a few typos, etc.), mostly to documentation but also in a few code comments. No changes were made to any of the code in the package.
A few other notes:
<-and=throughout the package. I don't feel strongly about it, so I defer to the package authors and maintainers. But again, it would be good to pick one style and use it consistently throughout the package.