Skip to content

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

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Closed
thatlittleboy opened this issue Feb 19, 2022 · 1 comment · Fixed by #136
Closed

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

thatlittleboy opened this issue Feb 19, 2022 · 1 comment · Fixed by #136

Comments

@thatlittleboy
Copy link
Contributor

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
Copy link
Member

pawamoy commented Feb 19, 2022

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 😄 Of course, feel free to send a new PR, this is highly appreciated!

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging a pull request may close this issue.

2 participants