fix: roxygen2 warnings and improve doc formatting #2388
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
it's senseless to inherit params from the same topic (same `@rdname`) and hence roxygen2 warns about it
this fixes roxygen2 warnings and is the right thing to do, cf.: - https://roxygen2.r-lib.org/articles/namespace.html#s3 - r-lib/roxygen2#1322
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.
Fixes all roxygen2 warnings and improves documentation formatting at some places. See the individual commits for details.
Some more useful info on
@exporting S3 methods is found in this comment by Garrick Aden-Buie: r-lib/roxygen2#1592 (comment)