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.

Sign up for GitHub

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

Jump to bottom

Indicate internal functions #150

Merged
merged 1 commit into from
Nov 27, 2024
Merged

Indicate internal functions #150

merged 1 commit into from
Nov 27, 2024

Conversation

BatoolMM
Copy link
Member

@BatoolMM BatoolMM commented Nov 27, 2024 •
edited by RayStick
Loading

References #147

Proposed Changes

  • I have added keywords internal to make sure that the functions are marked as internal in the documentation.
  • I have explicitly indicated these functions are helpers in the docs.

Checklist before review:

  • Please comment on my PR while it's a draft and give me feedback on the development!
  • I added everything I wanted to add to this PR, please review!
  • The code base and the documentation match (they both reflect any recent changes).
  • The title of this PR is clear and self-explantory.
  • I added any appropriate labels to this PR.

@BatoolMM BatoolMM changed the title Indicate internal functions [WIP] Indicate internal functions Nov 27, 2024
@BatoolMM BatoolMM added the enhancement Feature improvement or addition label Nov 27, 2024
@BatoolMM BatoolMM linked an issue Nov 27, 2024 that may be closed by this pull request
pkgcheck results - main #147
Closed
RayStick
RayStick approved these changes Nov 27, 2024
View reviewed changes
Copy link
Member

@RayStick RayStick left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This looks great - thanks Batool

@RayStick RayStick merged commit c602975 into main Nov 27, 2024
9 checks passed
@RayStick
Copy link
Member

RayStick commented Nov 27, 2024 •
edited
Loading

@BatoolMM realised I should have prompted you to do
devtools::document() to make sure the .Rd files updated
but I forgot, so I did it here afterwards: 465f78e

I am going to update the PR template soon

@RayStick
Copy link
Member

@all-contributors add @BatoolMM for documentation

@allcontributors allcontributors bot mentioned this pull request Nov 27, 2024
Merged
@allcontributors AllContributors
Copy link
Contributor

@RayStick

I've put up a pull request to add @BatoolMM! 🎉

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@RayStick RayStick RayStick approved these changes

Assignees

@BatoolMM BatoolMM

Labels
enhancement Feature improvement or addition ready for review
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.

pkgcheck results - main
2 participants
@BatoolMM @RayStick