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

Expose statistic function arguments in analyze functions #1133

Closed
edelarua opened this issue Nov 16, 2023 · 0 comments · Fixed by #1134
Closed

Expose statistic function arguments in analyze functions #1133

edelarua opened this issue Nov 16, 2023 · 0 comments · Fixed by #1134
Assignees
Labels
documentation Improvements or additions to documentation enhancement sme

Comments

@edelarua
Copy link
Contributor

edelarua commented Nov 16, 2023

Most analyze functions currently require arguments that are not explicitly listed in their arguments. These arguments (as well as optional settings specific to the function) should be exposed to the user so that they know what is required to use the function. This way users are not also required to read the documentation for the associated statistic function when using an analyze function and error messages relating to these arguments are more coherent.

For example, the thresholds argument is required to use count_cumulative but this argument is not listed in the usage section for count_cumulative, only for s_count_cumulative.

This update will also be useful later on when refactoring analyze functions and when statistics functions are moved to the tern.s package.

Part of #1130

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 enhancement sme
Projects
None yet
Development

Successfully merging a pull request may close this issue.

1 participant