numpydoc

numpydoc copied to clipboard

I apologize in advance if I have missed something seeking previous discussion on the topic. I am finding some issues with following the numpydoc style guide wrt modules and packages....

sergiocallegari

The numpydoc linter pretends that `**kwargs` is documented in params or other params **as such**. IMHO this makes little sense since the construct serves to have *arbitrary* parameter names. IMHO...

sergiocallegari

Failure to parse docstrings where a section contains header-like content

1

`numpydoc.docscrape.NumpyDocString` in version 1.9.0 fails to parse docstrings if there is content within a section that resembles a section header, e.g. the `"Parameters\n----------"` contains `" Parameters\n----------"` Example reproducer: a function...

aaronfng