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.

Sign up for GitHub

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

Fix notification docs to mention Set as well as List and Dict #1617

Closed
wants to merge 2 commits into from
Closed

Fix notification docs to mention Set as well as List and Dict #1617

Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
89020a9
Fix notification docs to mention Set as well as List and Dict
mdickinson Feb 10, 2022
bc4bdcc
Fix pre-existing typo
mdickinson Feb 10, 2022
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
6 changes: 4 additions & 2 deletions docs/source/traits_user_manual/listening.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -314,12 +314,14 @@ These signatures use the following parameters:
.. index:: new parameter to the notification handlers

* *new*: The new value of the trait attribute that changed. For changes to
List and Dict objects, this is a list of items that were added.
List and Dict objects, this is a list of items that were added. For changes
to Set objects, this is a set of items that were added.

.. index:: old parameter to the notification handlers

* *old*: The old value of the trait attribute that changed. For changes to List
and Dict object, this is a list of items that were deleted. For event traits,
and Dict objects, this is a list of items that were deleted. For changes to
Set objects, this is a set of items that were deleted. For event traits,
this is Undefined.

If the handler is a bound method, it also implicitly has *self* as a first
Expand Down