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.

Sign up for GitHub

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

Jump to bottom

Update Python doc-strings #198

Open
CasperWA opened this issue Aug 18, 2021 · 1 comment
Open

Update Python doc-strings #198

CasperWA opened this issue Aug 18, 2021 · 1 comment
Labels
documentation Improvements or additions to documentation

Comments

@CasperWA
Copy link
Collaborator

mkdocstrings will be used to generate the API reference.
Here is their documentation section on supported doc-string styles.
@CasperWA CasperWA added the documentation Improvements or additions to documentation label Aug 18, 2021
@CasperWA
Copy link
Collaborator Author

It might be fitting to include mypy when doing this, and not before (see #223 for further discussion on this).

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees
No one assigned
Labels
documentation Improvements or additions to documentation
Projects
None yet
Milestone
No milestone
Development

No branches or pull requests
1 participant
@CasperWA