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

Documentation: Clarify Export, NoRd, internal usage #346

Open
bms63 opened this issue Nov 7, 2023 · 0 comments
Open

Documentation: Clarify Export, NoRd, internal usage #346

bms63 opened this issue Nov 7, 2023 · 0 comments
Labels
documentation Improvements or additions to documentation

Comments

@bms63
Copy link
Collaborator

bms63 commented Nov 7, 2023

Please select a category the issue is focused on?

Function Documentation

Let us know where something needs a refresh or put your idea here!

All Functions should be well-documented and follow all our guidelines. However, some functions a user will never need in their code and we should reduce function-docs overload as much as possible.

We should clarify the use of @export, @noRd and @keyword internal and provide guidance on when to:

  • export a function
  • not export a function
  • export a function but hide from reference page
  • use of @nord -
  • use of internal for keyword

See for example
pharmaverse/admiral#2220 (comment)

@bms63 bms63 added the documentation Improvements or additions to documentation label Nov 7, 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
Development

No branches or pull requests

1 participant