Skip to content

Improve subscribe documentation. #154

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

Merged
Thom1729 merged 1 commit into from
Apr 4, 2021
Merged

Improve subscribe documentation. #154

Changes from all commits
Commits
Show all changes
1 commit
Select commit
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: 6 additions & 0 deletions st3/sublime_lib/settings_dict.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -173,6 +173,12 @@ def subscribe(
then ``self.get(selector, default_value)`` is passed.
Otherwise, ``projection(self, selector)`` is passed.

Changes in the selected value are detected
by comparing the last known value to the current value
using the equality operator.
If you use a selector function,
the result must be equatable and should not be mutated.

`callback` should accept two arguments:
the new derived value and the previous derived value.

Expand Down