Document the '-' pattern for on_trait_change. #1592
Merged
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
rahulporuri
approved these changes
Nov 5, 2021
| registers one trait-level notifier for each trait on the target object, | ||
| while the ``"-"`` pattern registers a single *object*-level notifier on the | ||
| target object. As a result, a | ||
| ``some_object.on_trait_change(handler, "-")`` call may be more performant |
There was a problem hiding this comment.
I'd suggest something more general, like "may have different performance characteristics" - I can see situations where either might be better depending on the number of traits, how often instances are created and how often they change.
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.
Fixes #1589.