Documentation: make function argument sections consistent #90
Labels
Discussion
Action or process of talking about something in order to reach a decision or to exchange ideas.
Documentation
Material that provides official information or evidence or that serves as a record.
ON HOLD
Projects
Please select a category the issue is focused on?
Function Documentation
Let us know where something needs a refresh or put your idea here!
tester feedback:
Comparing for example https://pharmaverse.github.io/admiralonco/test/reference/derive_param_bor.html#arguments with https://pharmaverse.github.io/admiralonco/test/reference/derive_param_confirmed_bor.html#arguments we got the feedback:
the "Arguments" documentation is not same across all functions: for eg "derive_param_bor" had provided if the parameter is required or not. but if we look into consistency across all references to provide permistted values, optional or not, defualt values.
also see pharmaverse/admiraldev#72 from admiral.
we should include the useful PERMITTED VALUES and DEFAULT VALUES sections in all functions. around REQUIRED/OPTIONAL part this is still being discussed at admiral dev team and i will add here the decision.
The text was updated successfully, but these errors were encountered: