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

Add examples for await-outside-async and fix activation of message #6016

Merged
merged 3 commits into from
Mar 28, 2022

Conversation

DudeNr33
Copy link
Collaborator

  • Add a ChangeLog entry describing what your PR does.
  • Write a good description on what the PR does.
  • If you used multiple emails or multiple names when contributing, add your mails
    and preferred name in script/.contributors_aliases.json

Type of Changes

Type
🐛 Bug fix
✨ New feature
🔨 Refactoring
📜 Docs

Description

This adds examples and link to the relevant PEP for await-outside-async.
The new test case for checking the message docs actually found a bug (which cost me more time to find than I'd be willing to admit 😀 ):
Because the relevant visit_await method was implemented in the wrong checker class (there are two in the module), it was not possible to disable all messages and then just enable await-outside-async again.
As both the impact and the fix of this are so minor I decided to directly fix this in this PR and only add a ChangeLog entry, without separate issue or whatsnew entry.
Let me know if you'd rather want to split this into two PRs.

Ref: #5953

Copy link
Collaborator

@DanielNoord DanielNoord left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Thanks @DudeNr33!

Nice to see how this process is finding some hard to spot issue as well. I have also found some missing check_messages through this process 😄

@coveralls
Copy link

Pull Request Test Coverage Report for Build 2052735367

  • 12 of 12 (100.0%) changed or added relevant lines in 1 file are covered.
  • No unchanged relevant lines lost coverage.
  • Overall coverage remained the same at 94.154%

Totals Coverage Status
Change from base Build 2051790443: 0.0%
Covered Lines: 15334
Relevant Lines: 16286

💛 - Coveralls

@DanielNoord DanielNoord merged commit d9d45ba into pylint-dev:main Mar 28, 2022
@Pierre-Sassoulas
Copy link
Member

Because the relevant visit_await method was implemented in the wrong checker class (there are two in the module), it was not possible to disable all messages and then just enable await-outside-async again.

Sounds like something that is supposed to take some time to find out 😄 Thanks for the debug !

@DudeNr33 DudeNr33 deleted the doc-await-outside-async branch March 29, 2022 05:01
@Pierre-Sassoulas Pierre-Sassoulas removed this from the 2.14.0 milestone May 17, 2022
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

Successfully merging this pull request may close these issues.

4 participants