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

update API doc strings in framework for public-facing APIs #38

Open
gregcaporaso opened this issue Mar 13, 2024 · 0 comments
Open

update API doc strings in framework for public-facing APIs #38

gregcaporaso opened this issue Mar 13, 2024 · 0 comments
Labels
content improvement An improvement to existing content. general Related to multiple parts. help wanted Assistance is welcomed.

Comments

@gregcaporaso
Copy link
Member

gregcaporaso commented Mar 13, 2024

Many of these either don't have doc strings, or have some formatting in the doc strings that doesn't align with either the Numpy or Google conventions. As part of this effort, we should choose whether we prefer the Numpy or Google convention and use that throughout.

This work will primarily happen in the QIIME 2 framework codebase, though there should be content updates in DWQ2 as new API documentation is produced.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
content improvement An improvement to existing content. general Related to multiple parts. help wanted Assistance is welcomed.
Projects
None yet
Development

No branches or pull requests

1 participant