DOC clarify attrs.define generated class example - #1622
Open
zihjiang wants to merge 1 commit into
Open
Conversation
This file contains hidden or 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
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.
Problem
The
@attrs.defineexample in the “hand-written classes” section shows a__hash__method even though the decorator's defaults produce unhashable classes. It also omits the default slots generated byattrs.define, which makes the comparison misleading.Changes
__slots__to the equivalent hand-written example.__hash__method from the example.@attrs.definedefaults explicitly.Testing
uv run tox run -e docs-builduv run prek run --files docs/why.mdgit diff --checkRelated issue
Closes #1472
AI disclosure
AI assistance was used to locate and draft this small documentation change. I reviewed the issue, contribution policy, resulting diff, and validation output, and I understand and take responsibility for the submitted change.