-
Notifications
You must be signed in to change notification settings - Fork 3
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Improve roxygen documentation #115
Merged
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
RasmusSkytte
force-pushed
the
feature/documentation_overhaul
branch
2 times, most recently
from
February 22, 2024 08:41
63134aa
to
6d4dbe9
Compare
RasmusSkytte
force-pushed
the
feature/documentation_overhaul
branch
from
February 22, 2024 09:54
6955458
to
0561a5e
Compare
LasseEngboChr
approved these changes
Feb 22, 2024
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Lots of small adjustments to align the style :-)
Only a couple of suggestions.
6 tasks
Fixes #69 |
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.
Intent
This PR takes a thorough look at the roxygen documentation and aligns the style internally and with the mlr3 style.
(This fixes the
param_and_field_linter()
lints we have been getting since merging PR #102)In addition, some use of the
db_table_id
argument have been renamed todb_table
to align names of arguments across functions.The recent updates to
id()
, means that there we no longer need to supply anId
but just something coercible byid()
.There also was some imports libraries that was causing issues. I removed these from imports and instead ensured every function call was visibly binded.
This also meant we could have fewer dependencies and move some dependencies to "Suggests" and not rely on these.
Approach
db_table_id
renamed todb_table
.Roxygen docs:
Datatypes of arguments have been made explicit by adding the specification
(`<datatype>()`)\cr
to all function args.The indentation of roxygen docs have been aligned across functions
The order of roxygen tags have been aligned (but is not actively enforced)
Punctuation marks added throughout.
Examples made conditional on the installation status of
RSQLite
.This mean that with a few more changes, we could move
RSQLite
to "Suggests" and don't have it as a dependency.Known issues
N/A
Checklist
NEWS.md