Minor improvements to docs / error messages #13
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
Have rebuilt man/ files but not README.md (from README.Rmd) Improvements include general spelling/grammar fixes, capitalising URL, standardising no full stop at end of final sentence of @param, clarifying `polite`, `session` instead of `polite session`, using backticks more for e.g. package names and TRUE/FALSE Added title to print.polite docs
|
Thank you very much! |
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.
Thanks very much for this package. I've proofread the documentation and error messages and suggested some improvements. Happy to adapt as necessary.
Improvements include general spelling/grammar fixes, capitalising 'URL', standardising no full stop at the end of the final sentence of parameter explanations (
@param), clarifying 'polite,session' instead of 'polite session', using backticks more for e.g. package names and TRUE/FALSEI've also added a title to the
print.politedocs to allow these to be made bydevtools::document().I've rebuilt the
man/files but notREADME.md(fromREADME.Rmd) as knitting this in RStudio introduced a lot of artefacts. Could you possibly rebuildREADME.mdplease?