aiidateam / qe-tools

A set of useful tools for Quantum ESPRESSO
MIT License
28 stars 13 forks source link

Check and update docstrings #45

Open greschd opened 4 years ago

greschd commented 4 years ago

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