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: make function argument sections consistent #90

Closed
rossfarrugia opened this issue Jul 28, 2022 · 2 comments
Closed

Documentation: make function argument sections consistent #90

rossfarrugia opened this issue Jul 28, 2022 · 2 comments
Assignees
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

Comments

@rossfarrugia
Copy link
Contributor

rossfarrugia commented Jul 28, 2022

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.

@rossfarrugia rossfarrugia added the Documentation Material that provides official information or evidence or that serves as a record. label Jul 28, 2022
@rossfarrugia rossfarrugia added this to Backlog in admiralonco Project Board via automation Jul 28, 2022
@rossfarrugia rossfarrugia moved this from Backlog to To do - For this sprint in admiralonco Project Board Jul 28, 2022
@rossfarrugia rossfarrugia added Discussion Action or process of talking about something in order to reach a decision or to exchange ideas. ON HOLD labels Jul 28, 2022
@rossfarrugia rossfarrugia moved this from To do - For this sprint to Backlog in admiralonco Project Board Aug 3, 2022
@rossfarrugia
Copy link
Contributor Author

Waiting for decision from admiral core team on the issue mentioned above - and a programming strategy update.

@bundfussr
Copy link
Collaborator

The admiralonco functions are superseded by derive_extreme_event(). I would not expect that we develop them further. Thus I am closing this issue.

admiralonco Project Board automation moved this from Backlog to Done Sep 28, 2023
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
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
Development

No branches or pull requests

3 participants