fix docs for eq-without-hash #14885
Open
fix docs for eq-without-hash #14885
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
|
dhruvmanila
reviewed
Dec 10, 2024
Comment on lines
-14
to
+17
| /// method implicitly set to `None`. This will cause the class to be | ||
| /// unhashable, will in turn cause issues when using the class as a key in a | ||
| /// dictionary or a member of a set. | ||
| /// | ||
| /// ## Known problems | ||
| /// Does not check for `__hash__` implementations in superclasses. | ||
| /// method implicitly set to `None`, regardless of if a super class defines | ||
| /// `__hash__`. This will cause the class to be unhashable, will in turn | ||
| /// cause issues when using the class as a key in a dictionary or a member | ||
| /// of a set. |
There was a problem hiding this comment.
I think we should provide an additional example below for the case where a superclass has defined a __hash__ method and still the subclass is unhashable because Python will not inherit it and provide a link to https://docs.python.org/3/reference/datamodel.html#object.__hash__.
MichaReiser
changed the title
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Summary
resolves #14883
Test Plan
used a spell checker