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 and validation for optional arguments for annotate/classify #124

Merged
merged 3 commits into from Sep 21, 2022

Conversation

yetinam
Copy link
Member

@yetinam yetinam commented Sep 14, 2022

This PR cleans up the optional arguments for annotate/classify and their documentation. It contains three contributions:

  • A Sphinx extension to automatically document all optional arguments.
  • A parameter validation for the optional arguments. Any unknown argument passed to annotate/classify will raise a warning.
  • Default values for all parameters are now defined centrally in the _annotate_args dictionary instead as scattered throughout the code.

Closes #100

@yetinam yetinam added documentation Improvements or additions to documentation enhancement New feature or request labels Sep 14, 2022
@yetinam yetinam added this to the v0.3 milestone Sep 14, 2022
@yetinam
Copy link
Member Author

yetinam commented Sep 14, 2022

CI failures seem to be related to the scipy version and are most likely unrelated to the changes. I'll have a look into it in the next days. Please do the review anyhow.

@yetinam
Copy link
Member Author

yetinam commented Sep 19, 2022

CI failure should be fixed now.

Copy link
Contributor

@jawooll jawooll left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Looks good, love the directive you've added for extensibility. Merging now.

@jawooll jawooll merged commit c57c619 into main Sep 21, 2022
@jawooll jawooll deleted the annotate_params_doc_validate branch September 21, 2022 09:39
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 New feature or request
Projects
None yet
Development

Successfully merging this pull request may close these issues.

Clean documentation for auxiliary parameters in annotate/classify
2 participants