quantumlib
Inconsistent docstring line lengths
A few years ago we switched to using black to auto-format and set the character width at 100. When we did this, we ended up with a lot of doc strings that were not touched and so are 80 characters. We now have both 80 or 100 or a mixture of docstrings.
-
Would be nice to just standardize on one width going forward, just so we don't have to think about it. Possibly also say new docstring follow this, old ones are ok.
-
We could use a docstring format enforcer. The best I've found so far is https://github.com/PyCQA/docformatter . It is not super aggressive, if your description in a doc string has special characters, it prefers not to wrap things.
Low priority.
Marked discuss even though we already had a discussion about this since it seems to me that there are still some unknowns, e.g. which tool to use.
In going through the annotations of docformatter, there are lots of methods that have multiline doc strings that don't follow PEP 257 in that they don't have a single line comment followed by a space, but are instead multiline right of the bat. Other than that it seems to make pretty reasonable choices.
