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

Update outdated class name in "How to Write a Checker" test example #5449

Merged
merged 3 commits into from Dec 3, 2021

Conversation

pylbrecht
Copy link
Contributor

pylint.testutils.Message got first renamed to pylint.testutils.TestMessage in 49776ac and finally renamed to pylint.testutils.MessageTest in 24cbf8c.

Documentation was not updated to use the new class name.

Type of Changes

Type
📜 Docs

Description

`pylint.testutils.Message` got first renamed to
`pylint.testutils.TestMessage` in 49776ac and finally renamed to
`pylint.testutils.MessageTest` in 24cbf8c.
@pylbrecht
Copy link
Contributor Author

pylbrecht commented Dec 1, 2021

This is still a WIP until I finish all these open tasks for submitting a PR:

  • Add yourself to CONTRIBUTORS if you are a new contributor.
  • Add a ChangeLog entry describing what your PR does.
  • Write a good description on what the PR does.

@coveralls
Copy link

coveralls commented Dec 1, 2021

Pull Request Test Coverage Report for Build 1535144340

  • 0 of 0 changed or added relevant lines in 0 files are covered.
  • No unchanged relevant lines lost coverage.
  • Overall coverage remained the same at 93.538%

Totals Coverage Status
Change from base Build 1535104011: 0.0%
Covered Lines: 14026
Relevant Lines: 14995

💛 - Coveralls

@pylbrecht
Copy link
Contributor Author

pylbrecht commented Dec 1, 2021

I'm a bit unsure if and how to go about adding an entry to ChangeLog.
Is it necessary in this case? I only see "What's new?" enries and I don't feel this tiny documentation update belongs there.

// edit:

Nevermind, I just looked through your contributing document, which tells me a changelog entry is not necessary in this case:

Add a short entry to the ChangeLog describing the change, except for internal implementation only changes. Not usually required, but for changes other than small bugs we also add a couple of sentences in the release document for that release, (What's New section). For the release document we usually write some more details, and it is also a good place to offer examples on how the new change is supposed to work.

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.

It's ok if there is no changelog for this one, thank you for making the documentation better and congrat on becoming a contributor :) For the next MR you'll be trusted enough to run the github action without approval 😉

@Pierre-Sassoulas Pierre-Sassoulas marked this pull request as ready for review December 1, 2021 10:34
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.

I did not know about this part of the docs. Seems like we might want to update it as it would be a source of new unittests instead of functional tests. @Pierre-Sassoulas

The change itself looks good though. Thanks! 😄

@Pierre-Sassoulas Pierre-Sassoulas modified the milestones: 2.13.0, 2.12.2 Dec 3, 2021
@Pierre-Sassoulas Pierre-Sassoulas merged commit 28a33ef 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
Projects
None yet
Development

Successfully merging this pull request may close these issues.

None yet

4 participants