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

False positive for missing-yield-type-doc in annotated generator #3185

Closed
mwchase opened this issue Oct 11, 2019 · 0 comments · Fixed by #3195
Closed

False positive for missing-yield-type-doc in annotated generator #3185

mwchase opened this issue Oct 11, 2019 · 0 comments · Fixed by #3195
Labels
Bug 🪲 Good first issue Friendly and approachable by new contributors

Comments

@mwchase
Copy link

mwchase commented Oct 11, 2019

Steps to reproduce

  1. Enable the pylint.extensions.docparams plugin in pylintrc
  2. Run against the following file:
"""Small repro"""

import typing


def generator() -> typing.Iterator[int]:
    """A simple function for reproducing a pylint bug.

    Yields:
        The number 0
    """
    yield 0

Current behavior

pylint repro.py 
************* Module repro
repro.py:6:0: W9014: Missing yield type documentation (missing-yield-type-doc)

Expected behavior

No warning.

pylint --version output

pylint 2.4.2
astroid 2.3.1
Python 3.7.4 (default, Aug 27 2019, 22:43:30) 
[Clang 10.0.0 (clang-1000.11.45.5)]
@PCManticore PCManticore added Bug 🪲 Good first issue Friendly and approachable by new contributors labels Oct 15, 2019
AWhetter added a commit to AWhetter/pylint that referenced this issue Oct 17, 2019
AWhetter added a commit to AWhetter/pylint that referenced this issue Oct 17, 2019
AWhetter added a commit to AWhetter/pylint that referenced this issue Oct 17, 2019
AWhetter added a commit to AWhetter/pylint that referenced this issue Oct 17, 2019
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Bug 🪲 Good first issue Friendly and approachable by new contributors
Projects
None yet
Development

Successfully merging a pull request may close this issue.

2 participants