Skip to content
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 16 commits into from
Feb 23, 2024
Merged

Conversation

RasmusSkytte
Copy link
Contributor

@RasmusSkytte RasmusSkytte commented Feb 22, 2024

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 to db_table to align names of arguments across functions.
The recent updates to id(), means that there we no longer need to supply an Id but just something coercible by id().

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

  • Argument db_table_id renamed to db_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)

    • title
    • description
    • param
    • return
    • examples
    • imports
    • export
  • 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

  • The PR passes all local unit tests
  • I have documented any new features introduced
  • If the PR adds a new feature, please add an entry in NEWS.md
  • A reviewer is assigned to this PR

@RasmusSkytte RasmusSkytte changed the title chore: Remove unused templates Improve documentation Feb 22, 2024
@RasmusSkytte RasmusSkytte changed the title Improve documentation Improve roxygen documentation Feb 22, 2024
@RasmusSkytte RasmusSkytte self-assigned this Feb 22, 2024
@RasmusSkytte RasmusSkytte force-pushed the feature/documentation_overhaul branch 2 times, most recently from 63134aa to 6d4dbe9 Compare February 22, 2024 08:41
@RasmusSkytte RasmusSkytte added the documentation Improvements or additions to documentation label Feb 22, 2024
@RasmusSkytte RasmusSkytte added this to the v0.4 milestone Feb 22, 2024
@RasmusSkytte RasmusSkytte marked this pull request as ready for review February 22, 2024 10:27
R/get_tables.R Outdated Show resolved Hide resolved
R/helpers.R Outdated Show resolved Hide resolved
man-roxygen/add.R Outdated Show resolved Hide resolved
Copy link
Contributor

@LasseEngboChr LasseEngboChr left a 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.

@RasmusSkytte
Copy link
Contributor Author

Fixes #69

@RasmusSkytte RasmusSkytte merged commit 869c8e0 into main Feb 23, 2024
25 checks passed
@RasmusSkytte RasmusSkytte deleted the feature/documentation_overhaul branch February 23, 2024 07:54
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation Improvements or additions to documentation
Projects
None yet
Development

Successfully merging this pull request may close these issues.

None yet

2 participants