Update package style and documentation #178
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
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.
This PR updates the package coding style and function documentation. These changes address comments from the full package review (PR #151).
The package coding style has followed the tidyverse style, but this PR applies a {styler} (using
styler::style_pkg()) to enforce a consistency style. This is checked withlintr::lint_package()and the lint workflow which uses the .lintr file in the package root.The function documentation has been updated to firstly be more consistent across functions. It now uses imperative function descriptions in the
@titleand@description. It uses a{packagename}<classname>style. It makes use of inheritance provided by {roxygen2} (@inheritand@inheritParams) to remove duplicated docs. Descriptions, parameter documentation and return values are all sentences ending in a full stop. The clarity and wording of some functions has been improved.