improve documentation #176
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
nanxstats
requested changes
Nov 15, 2023
There was a problem hiding this comment.
This looks good, I only have a few minor suggestions:
Overall
Please rerun roxygen2 via devtools::document() and include the updated man/*.Rd in the PR.
Copyright section
- I would prefer the copyright section content remain untouched in most cases as it comes from a template. If an update is really necessary, such as updating the copyright year, the edits should happen consistently across all files.
- "Software" is used as a mass noun so the original usage "is free software" without "a" is correct.
Comments
- From tidyverse style guide: Comments should be in sentence case, and only end with a full stop if they contain at least two sentences. Looks like some one-sentence comments have an extra full stop that should be removed.
Improve documentation style metalite.ae
nanxstats
approved these changes
Feb 7, 2024
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.
Closes #157