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 is considered as missing in documentation #3733

Closed
biomael opened this issue Jul 10, 2020 · 3 comments · Fixed by #5175
Closed

*args is considered as missing in documentation #3733

biomael opened this issue Jul 10, 2020 · 3 comments · Fixed by #5175
Assignees
Labels
Milestone

Comments

@biomael
Copy link

biomael commented Jul 10, 2020

Hi, I met an issue with the following code:

def function(file, *args, sep=";"):
    """Description of the function

    Parameters
    ----------
    file : str
        Path to the input.
    *args
        Relevant parameters.
    sep : str, optional
        File separator.
    """

Current behavior

Return this warning: W9015: "args" missing in parameter documentation (missing-param-doc)

Expected behavior

No warning must be returned as there is a documentation concerning *args

pylint --version output

pylint 2.5.3
astroid 2.4.2
Python 3.7.2 (default, Feb 25 2019, 14:07:05)
[GCC 4.8.5 20150623 (Red Hat 4.8.5-36)]

@cdce8p
Copy link
Member

cdce8p commented Oct 17, 2021

@DanielNoord Would you like to take a look at this? I'm unable to reproduce it with main.

@DanielNoord
Copy link
Collaborator

I'm able to reproduce this.

Adding pylint.extensions.docparams to load-plugins and no-docstring-rgx=__.*__ makes this warning emit for me.

I have a feeling it might be because of the * because the message reports it is missing for args instead of *args. I will take a look!

@DanielNoord DanielNoord self-assigned this Oct 17, 2021
DanielNoord added a commit to DanielNoord/pylint that referenced this issue Oct 17, 2021
@cdce8p
Copy link
Member

cdce8p commented Oct 17, 2021

Thanks @DanielNoord

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

Successfully merging a pull request may close this issue.

5 participants