PyCQA/pylint

Enhance the testing for docstrings so that it needs arguments if there are attributes that are not the self attribute #8170

ollie-iterators posted onGitHub

Current problem

It would be good if docstrings required having a description of what the attributes in the function are used to to complete the docstring

Desired solution

When I make a docstring it would be nice if it were necessary to add the attribute information for the docstring

Additional context

No response


You should use the doc param checker, add this to the load-plugins option: pylint.extensions.docparams. See doc here : https://pylint.readthedocs.io/en/latest/user_guide/checkers/extensions.html#pylint-extensions-docparams

posted by Pierre-Sassoulas almost 2 years ago

Fund this Issue

$0.00
Funded

Pull requests