Skip to content

Conversation

@the-mayer
Copy link
Collaborator

Description

Overtime, the .Rd files have drifted from changes to the roxygen2 comments in the package. This PR simply updates all .Rd tags, so that roxygen comments and documentation are once again in sync

What kind of change(s) are included?

  • Feature (adds or updates new capabilities)
  • Bug fix (fixes an issue).
  • Enhancement (adds functionality).
  • Breaking change (these changes would cause existing functionality to not work as expected).

Checklist

Please ensure that all boxes are checked before indicating that this pull request is ready for review.

  • I have read and followed the CONTRIBUTING.md guidelines.
  • I have searched for existing content to ensure this is not a duplicate.
  • I have performed a self-review of these additions (including spelling, grammar, and related).
  • I have added comments to my code to help provide understanding.
  • I have added a test which covers the code changes found within this PR.
  • I have deleted all non-relevant text in this pull request template.
  • Reviewer assignment: Tag a relevant team member to review and approve the changes.

@the-mayer the-mayer self-assigned this Oct 1, 2025
@the-mayer the-mayer added documentation Improvements or additions to documentation, incl. R docstring/roxygen2 cleanup Rm deadcode & duplication, streamline labels Oct 1, 2025
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

cleanup Rm deadcode & duplication, streamline documentation Improvements or additions to documentation, incl. R docstring/roxygen2

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants