Skip to content
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

*args and **kwargs lines in Numpydoc parameter sections fail to parse #43

Closed
FasterSpeeding opened this issue Feb 18, 2022 · 1 comment

Comments

@FasterSpeeding
Copy link
Contributor

Describe the bug
Documentation for *args and **kwargs (as according to https://numpydoc.readthedocs.io/en/latest/format.html#parameters) fails to parse in Numpydoc Parameter and Other Parameter sections

To Reproduce
Trying to parse a docstring with the following docstring through numpydocstring

Parameters
------------
*args : typing.Any
    Pass through
**kwargs : typing.Any
    Pass through

Leads to the following being logged when using the versions specified below

WARNING  -  griffe: alluka\abc.py:461: Could not parse line '*args : typing.Any'
WARNING  -  griffe: alluka\abc.py:461: Could not parse line '**kwargs : typing.Any'
WARNING  -  griffe: alluka\abc.py:461: Empty parameters section at line 4

being logged

Expected behavior
These lines shouldn't fail to parse

Screenshots
If applicable, add screenshots to help explain your problem.

System (please complete the following information):
griffe == 0.12.5
mkdocstrings-python==0.6.2
py ver 3.10
OS: Win 12 - 1

Additional context
Add any other context about the problem here.

@FasterSpeeding FasterSpeeding changed the title *args and **kwargs in Numpydoc parameter sections *args and **kwargs lines in Numpydoc parameter sections fail to parse Feb 18, 2022
@pawamoy
Copy link
Member

pawamoy commented Feb 18, 2022

Fixed in version 0.12.6 🙂

@pawamoy pawamoy closed this as completed Feb 18, 2022
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

No branches or pull requests

2 participants