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

Note that sync_trait only synchronises items for List traits #1519

Merged
merged 1 commit into from
Sep 10, 2021
Merged
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
5 changes: 5 additions & 0 deletions traits/has_traits.py
Original file line number Diff line number Diff line change
Expand Up @@ -2700,6 +2700,11 @@ def sync_trait(
on this object causes the corresponding trait attribute of *object* to
be updated, but not vice versa.

For ``List`` traits, the list's items are also synchronized, so that
mutations to this trait's list will be reflected in the synchronized
list (and vice versa in the case of mutual synchronization). For
``Dict`` and ``Set`` traits, items are not synchronized.

Parameters
----------
name : str
Expand Down