Skip to content

This issue was moved to a discussion.

You can continue the conversation there. Go to discussion →

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: Centralized issue for all things roclet-related for function argument default/permitted values #1976

Closed
zdz2101 opened this issue Jun 21, 2023 · 0 comments
Labels
documentation Improvements or additions to documentation

Comments

@zdz2101
Copy link
Collaborator

zdz2101 commented Jun 21, 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!

In summary, in much of our roxygen documentation for function argument values we have inconsistencies on how to handle/display default and permitted values. Our best lead has been to implement a roxygen roclet to address these instances.

We have closed many issues along the way related to this topic but the remaining open issues are as follows:

From admiral:
#1402
#1590 (the beginning of the roclet)

From admiraldev:
pharmaverse/admiraldev#11
pharmaverse/admiraldev#64
pharmaverse/admiraldev#166
pharmaverse/admiraldev#270

From admiralonco:
pharmaverse/admiralonco#130 (lots of discussion was had here)

This issue was moved to a discussion.

You can continue the conversation there. Go to discussion →

Labels
documentation Improvements or additions to documentation
Development

No branches or pull requests

1 participant