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

Check and update docstrings #45

Open
greschd opened this issue Jun 15, 2020 · 0 comments
Open

Check and update docstrings #45

greschd opened this issue Jun 15, 2020 · 0 comments
Milestone

Comments

@greschd
Copy link
Member

greschd commented Jun 15, 2020

The docstrings, in particular of PwInputFile and CpInputFile, need to be checked and potentially updated. This is probably easier once #44 is done, so we can directly check the doc output.

An issue that definitely needs solving is that they have a docstring both at the class level and for the __init__. In the documentation, only one of the two will show.

It'd be nice to convert the docstrings to numpy-style while we're at it, see https://sphinxcontrib-napoleon.readthedocs.io/en/latest/example_numpy.html

@greschd greschd added this to the v2.0 milestone Jun 15, 2020
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

No branches or pull requests

1 participant