[DOCS] Docstrings don't match up with function parameters

mkdocstrings / pytkdocs

Load Python objects documentation.

https://mkdocstrings.github.io/pytkdocs

ISC License

50 stars 32 forks source link

[DOCS] Docstrings don't match up with function parameters #135

Closed thatlittleboy closed 2 years ago

thatlittleboy commented 2 years ago

While I was working on #134 , I realized many of the functions in pytkdocs.parsers.docstrings.numpy have wrongly annotated docstrings (params don't match up with what's written in docstring).

For example: https://github.com/mkdocstrings/pytkdocs/blob/master/src/pytkdocs/parsers/docstrings/numpy.py#L49

I think this could be a easy & quick fix --- shall I address this in a subsequent PR ? 🙂

pawamoy commented 2 years ago

Oh, indeed, thanks for catching that. The Numpy parser was added by @aschmu, and I admit I probably wasn't thorough when reviewing it, because, well... I never use Numpydoc :smile: Of course, feel free to send a new PR, this is highly appreciated!