Document that the Dict, List and Set trait types copy on assignment
#1402
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
…t with small examples
mdickinson
reviewed
Jan 20, 2021
mdickinson
approved these changes
Jan 20, 2021
I think #1403 covers this. |
D'oh! Of course it does, because that's the issue you opened after checking there wasn't already one. Sorry, and thank you! |
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.
closes #1226
This PR adds a statement to the docstrings of
Dict,List, andSetmentioning that they copy values on assignment. It also adds very brief clarifying examples like the ones mentioned on the issue, although those may be overkill for the docstring. I convinced myself they were useful additions, but if a reviewer disagrees I am happy to remove them.Also, this content would better be detailed (or should additionally be detailed) somewhere in the used manual. As mentioned on the issue though, we currently don't have good sections on collection types. There should be a separate issue for adding those sections if there isn't one already opened (I will check shortly).
Checklist
[ ] Tests[ ] Update API reference (docs/source/traits_api_reference)docs/source/traits_user_manual)[ ] Update type annotation hints intraits-stubs