Closed kyleabeauchamp closed 4 years ago
I assume this you are on defopt<6; this was fixed in the very recently released defopt 6. (The help string is formatted not-so-optimally because napoleon introduces a lot of blank lines and we just copy them verbatim; I guess it should not be too hard to strip extra blank lines out ourselves.)
Upgrading from 5.1.0 to 6.0 fixes the issue, thank you!
I've noticed that certain numpy-style docstrings that contain either a
Note
orNotes
sections cause an exception to occur during CLI parsing. In the following example (largely copied from https://sphinxcontrib-napoleon.readthedocs.io/en/latest/example_numpy.html), I've taken their PEP484 example and added a singleNotes
section from another example on that page. The exception is posted below. If you simply rename the Notes section to be called any other word, things appear to work fine.