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.

Sign up for GitHub

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

Jump to bottom

#5452: Fix false positive missing-doc-param from multi-line Google-st… #5459

Merged
merged 5 commits into from Dec 3, 2021
Merged

#5452: Fix false positive missing-doc-param from multi-line Google-st… #5459

merged 5 commits into from Dec 3, 2021

Conversation

allanc65
Copy link
Contributor

@allanc65 allanc65 commented Dec 3, 2021 •
edited

…yle docstrings.

Type of Changes

Type
✓ 🐛 Bug fix
✓ ✨ New feature
✓ 🔨 Refactoring
✓ 📜 Docs

Description

Closes #5452

DanielNoord
DanielNoord requested changes Dec 3, 2021
View reviewed changes
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.

One small comment! Thanks @allanc65 😄

ChangeLog Outdated Show resolved Hide resolved
@DanielNoord
Copy link
Collaborator

One tip: if you add Closes #5452 to the PR description (your first comment) Github will know that it should link this PR with that issue and when we merge this PR it will automatically close that issue. That's very useful for project maintainers :)

@DanielNoord DanielNoord added the False Positive 🦟 A message is emitted but nothing is wrong with the code label Dec 3, 2021
@DanielNoord DanielNoord added this to the 2.12.2 milestone Dec 3, 2021
@allanc65 @DanielNoord
Update ChangeLog
12e433f 
Co-authored-by: Daniël van Noord <13665637+DanielNoord@users.noreply.github.com>
@coveralls
Copy link

coveralls commented Dec 3, 2021 •
edited

Pull Request Test Coverage Report for Build 1534773385

  • 3 of 3 (100.0%) changed or added relevant lines in 1 file are covered.
  • No unchanged relevant lines lost coverage.
  • Overall coverage increased (+0.02%) to 93.538%
Totals Coverage Status
Change from base Build 1532530778: 0.02%
Covered Lines: 14026
Relevant Lines: 14995
💛 - Coveralls

DanielNoord
DanielNoord requested changes Dec 3, 2021
View reviewed changes
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.

Oops, I just noticed you put missing_param_doc_required_Google.py in the wrong folder. It should be in tests/functional/ext/docparams/parameter/missing_param_doc_required_Google.py. Could you change this?

@allanc65
Copy link
Contributor Author

allanc65 commented Dec 3, 2021

Oops, I just noticed you put missing_param_doc_required_Google.py in the wrong folder. It should be in tests/functional/ext/docparams/parameter/missing_param_doc_required_Google.py. Could you change this?

Done. I also accepted your is/are change and added the issue number to comment 1 as suggested.

DanielNoord
DanielNoord approved these changes Dec 3, 2021
View reviewed changes
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.

👍🏻

Pierre-Sassoulas
Pierre-Sassoulas approved these changes Dec 3, 2021
View reviewed changes
Copy link
Member

@Pierre-Sassoulas Pierre-Sassoulas left a comment

Choose a reason for hiding this comment

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

Thank you for the analysis and the fix, and congratulation on becoming a pylint contributor 😉

@Pierre-Sassoulas Pierre-Sassoulas merged commit 4b70feb into pylint-dev:main Dec 3, 2021
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@Pierre-Sassoulas Pierre-Sassoulas Pierre-Sassoulas approved these changes

@DanielNoord DanielNoord DanielNoord approved these changes

Assignees
No one assigned
Labels
False Positive 🦟 A message is emitted but nothing is wrong with the code
Projects
None yet
Milestone
2.12.2
Development

Successfully merging this pull request may close these issues.

missing-param-doc differences between 2.11.1 and 2.12.1
4 participants
@allanc65 @DanielNoord @coveralls @Pierre-Sassoulas