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

check_docs accept-no-param-doc #735

Closed
rneu31 opened this issue Dec 11, 2015 · 3 comments
Closed

check_docs accept-no-param-doc #735

rneu31 opened this issue Dec 11, 2015 · 3 comments

Comments

@rneu31
Copy link

rneu31 commented Dec 11, 2015

Where in the pylintrc file should accept-no-param-doc=yes be specified?

The code below does not trigger warnings about missing documentation for arg_d, arg_e, nor arg_f.

def hello2(arg_d, arg_e, arg_f):
    """Hello.


    """
    arg_d = 4
    arg_e = 5
    arg_f = 4
    return arg_d, arg_e, arg_f
@PCManticore
Copy link
Contributor

This works by running pylint a.py -rn --load-plugins=pylint.extensions.check_docs --accept-no-param-doc=n or by putting accept-no-param-doc in MASTER section in pylintrc file. Hope this helps.

glennmatthews added a commit to glennmatthews/pylint that referenced this issue Jul 1, 2016
PCManticore added a commit that referenced this issue Jul 1, 2016
PCManticore pushed a commit that referenced this issue Jul 2, 2016
@stevekuznetsov
Copy link

This should really be documented better -- would never have thought to put it under the [MASTER] heading

@PCManticore
Copy link
Contributor

The problem is that extensions don't necessarily have their own section. Feel free to open a new issue if you have any suggestion for improving this.

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

3 participants