Skip to content

Consider @noRd for assert_* and any other non-exported functions #108

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

Closed
brookslogan opened this issue May 22, 2023 · 0 comments · Fixed by #125
Closed

Consider @noRd for assert_* and any other non-exported functions #108

brookslogan opened this issue May 22, 2023 · 0 comments · Fixed by #125
Assignees
Labels
documentation Improvements or additions to documentation P0 Top priority

Comments

@brookslogan
Copy link
Contributor

Even though these functions are not exported, they still will show up in the "Reference" with the exported functions. Assuming this is unintentional, we should add @noRd (no .Rd / compiled doc at all) or @keywords internal (documentation is compiled, but not listed in the "Reference" index); people seem to favor the first approach.

@dshemetov dshemetov added documentation Improvements or additions to documentation P0 Top priority labels May 26, 2023
@dsweber2 dsweber2 self-assigned this May 31, 2023
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 P0 Top priority
Projects
None yet
Development

Successfully merging a pull request may close this issue.

3 participants