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

Fixed missing-yield-type-doc ignoring type annotation #3195

Merged
merged 1 commit into from Oct 17, 2019

Conversation

AWhetter
Copy link
Contributor

Steps

  • [*] Add yourself to CONTRIBUTORS if you are a new contributor.
  • [*] Add a ChangeLog entry describing what your PR does.
  • [*] If it's a new feature or an important bug fix, add a What's New entry in doc/whatsnew/<current release.rst>.
  • [*] Write a good description on what the PR does.

Description

This fixes missing-yield-type-doc getting raised on a generator that has a type annotation and does not document a yield type. Returns documentation already caters for this case and so do parameters. Yields were missed out.

I've also removed a duplicate test.

Type of Changes

Type
🐛 Bug fix
✨ New feature
🔨 Refactoring
📜 Docs

Related Issue

Closes #3185

@coveralls
Copy link

Coverage Status

Coverage decreased (-0.03%) to 89.659% when pulling 61b5ae4 on AWhetter:fix_3185 into 6df0b3e on PyCQA:master.

2 similar comments
@coveralls
Copy link

Coverage Status

Coverage decreased (-0.03%) to 89.659% when pulling 61b5ae4 on AWhetter:fix_3185 into 6df0b3e on PyCQA:master.

@coveralls
Copy link

Coverage Status

Coverage decreased (-0.03%) to 89.659% when pulling 61b5ae4 on AWhetter:fix_3185 into 6df0b3e on PyCQA:master.

@coveralls
Copy link

coveralls commented Oct 17, 2019

Coverage Status

Coverage increased (+0.01%) to 89.701% when pulling d06c2d8 on AWhetter:fix_3185 into 6df0b3e on PyCQA:master.

@PCManticore
Copy link
Contributor

Thanks, I cherry-picked it to 2.4 as well.

@AWhetter AWhetter deleted the fix_3185 branch October 18, 2019 01:28
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

Successfully merging this pull request may close these issues.

False positive for missing-yield-type-doc in annotated generator
3 participants