Update docs to clarify the relationship between name and id #127
+7
−1
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
The name passed to new() defines the initial id, but changing it with name() does not change the id, it has to be changed explicitly with id(). This documentation update attempts to make this caveat more explicit, as it is not apparent from the public API without looking at the source.
Contributor
Author
|
This tripped me when I was upgrading to v0.32. I thought I could just set the new Should I add a docstring to every |
bircni
approved these changes
Aug 8, 2025
emilk
added
the
exclude from changelog
Owner
|
thanks! |
michalsustr
pushed a commit
that referenced
this pull request
Nov 26, 2025
Co-authored-by: Emil Ernerfeldt <emil.ernerfeldt@gmail.com>
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
3 participants
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.
The name passed to new() defines the initial id, but changing it with name() does not change the id, it has to be changed explicitly with id(). This documentation update attempts to make this caveat more explicit, as it is not apparent from the public API without looking at the source.