tf-encrypted icon indicating copy to clipboard operation
tf-encrypted copied to clipboard

Improve docstrings

Open jvmncs opened this issue 6 years ago • 1 comments

Related #474

Right now many of the docstrings required for linting are simple descriptors, but they don't follow the Google style guide. We should fix this for all non-trivial functions. We should consider doing this incrementally.

I suggest maintaining the current docstring formatting for classes and functions that currently get built for the docs. Once we get everything else to Google's style, we can modify Sphinx and then switch the documentation over for uniformity.

jvmncs avatar May 07 '19 21:05 jvmncs

One concrete objective is to no longer ignore D10,D20,D40 in setup.cfg

mortendahl avatar Feb 27 '20 15:02 mortendahl