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

Custom error message for comparison-with-callable #1130

Merged
merged 5 commits into from
Jan 13, 2025

Conversation

herenali
Copy link
Contributor

@herenali herenali commented Jan 11, 2025

Proposed Changes

Added custom error message for comparison-with-callable (W0143) to improve clarity of error message.

...

Updated error message

Type of Change

(Write an X or a brief description next to the type or types that best describe your changes.)

Type Applies?
🚨 Breaking change (fix or feature that would cause existing functionality to change)
New feature (non-breaking change that adds functionality)
🐛 Bug fix (non-breaking change that fixes an issue)
♻️ Refactoring (internal change to codebase, without changing functionality)
🚦 Test update (change that only adds or modifies tests)
📚 Documentation update (change that only updates documentation) X
📦 Dependency update (change that updates a dependency)
🔧 Internal (change that only affects developers or continuous integration)

Checklist

(Complete each of the following items for your pull request. Indicate that you have completed an item by changing the [ ] into a [x] in the raw text, or by clicking on the checkbox in the rendered description on GitHub.)

Before opening your pull request:

  • I have performed a self-review of my changes.
    • Check that all changed files included in this pull request are intentional changes.
    • Check that all changes are relevant to the purpose of this pull request, as described above.
  • I have added tests for my changes, if applicable.
    • This is required for all bug fixes and new features.
  • I have updated the project documentation, if applicable.
    • This is required for new features.
  • I have updated the project Changelog (this is required for all changes).
  • If this is my first contribution, I have added myself to the list of contributors.

After opening your pull request:

  • I have verified that the pre-commit.ci checks have passed.
  • I have verified that the CI tests have passed.
  • I have reviewed the test coverage changes reported by Coveralls.
  • I have requested a review from a project maintainer.

Questions and Comments

(Include any questions or comments you have regarding your changes.)

@coveralls
Copy link
Collaborator

coveralls commented Jan 11, 2025

Pull Request Test Coverage Report for Build 12736593179

Warning: This coverage report may be inaccurate.

This pull request's base commit is no longer the HEAD commit of its target branch. This means it includes changes from outside the original pull request, including, potentially, unrelated coverage changes.

Details

  • 0 of 0 changed or added relevant lines in 0 files are covered.
  • No unchanged relevant lines lost coverage.
  • Overall first build on custom-error-message at 92.509%

Totals Coverage Status
Change from base Build 12690545260: 92.5%
Covered Lines: 3211
Relevant Lines: 3471

💛 - Coveralls

@herenali herenali requested a review from david-yz-liu January 11, 2025 19:43
Copy link
Contributor

@david-yz-liu david-yz-liu 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, @herenali! I left some comments for the specific message, but otherwise looks good.

@@ -13,6 +13,7 @@ W0199 = "Calling assert on a tuple will only evaluate to False if it is empty. I

["pylint.checkers.base".ComparisonChecker]
C0123 = "You should use 'isinstance(x, my_type)' instead of 'type(x) == my_type' to check the type of a value."
W0143 = "This expression includes a comparison against a callable. It's likely you meant to call a function but omitted the parenthesis."
Copy link
Contributor

Choose a reason for hiding this comment

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

Let's use just the term "function" instead of "callable" in the description, as the latter isn't commonly taught for beginners.

And at the end, please say "parenthesis, ()" instead of just "parenthesis", just to be a bit more concrete.

@herenali herenali requested a review from david-yz-liu January 12, 2025 20:09
Copy link
Contributor

@david-yz-liu david-yz-liu left a comment

Choose a reason for hiding this comment

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

Thanks, @herenali!

@david-yz-liu david-yz-liu merged commit c3d8bb8 into pyta-uoft:master Jan 13, 2025
20 checks passed
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.

3 participants