-
-
Notifications
You must be signed in to change notification settings - Fork 1.1k
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
docparams should support missing type documentation when type comments are used #6287
Comments
AWhetter
added a commit
to AWhetter/pylint
that referenced
this issue
Apr 13, 2022
AWhetter
added a commit
to AWhetter/pylint
that referenced
this issue
Oct 14, 2022
AWhetter
added a commit
to AWhetter/pylint
that referenced
this issue
Oct 14, 2022
Pierre-Sassoulas
pushed a commit
to AWhetter/pylint
that referenced
this issue
Dec 12, 2022
Pierre-Sassoulas
added a commit
to AWhetter/pylint
that referenced
this issue
May 16, 2023
Closes pylint-dev#6287 Co-authored-by: Pierre Sassoulas <[email protected]>
Pierre-Sassoulas
added a commit
to AWhetter/pylint
that referenced
this issue
May 21, 2023
Closes pylint-dev#6287 Co-authored-by: Pierre Sassoulas <[email protected]>
Pierre-Sassoulas
added a commit
to AWhetter/pylint
that referenced
this issue
May 22, 2023
Closes pylint-dev#6287 Co-authored-by: Pierre Sassoulas <[email protected]>
AWhetter
added a commit
to AWhetter/pylint
that referenced
this issue
May 31, 2023
AWhetter
added a commit
to AWhetter/pylint
that referenced
this issue
Jun 13, 2023
AWhetter
added a commit
to AWhetter/pylint
that referenced
this issue
Jun 13, 2023
Pierre-Sassoulas
added a commit
that referenced
this issue
Jun 13, 2023
…6288) Closes #6287 Co-authored-by: Pierre Sassoulas <[email protected]>
Merged
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Current problem
When running pylint (
pylint --disable=all --enable=missing-type-doc --load-plugins=pylint.extensions.docparams code.py
) with the following code, no errors are displayed:However when type comments are used, a
missing-type-doc
warning is shown:Desired solution
Ideally docparams would allow type comments to count as type documentation, just like regular type annotations are allowed.
This will require changes on these lines: https://github.com/PyCQA/pylint/blob/a6cb836da56b051cdc0d584d726fb7579415cb54/pylint/extensions/docparams.py#L560-L563
Additional context
No response
The text was updated successfully, but these errors were encountered: