update notify docstrings to be more clear#78
Open
joe-p wants to merge 1 commit intohelix-editor:masterfrom
Open
update notify docstrings to be more clear#78joe-p wants to merge 1 commit intohelix-editor:masterfrom
joe-p wants to merge 1 commit intohelix-editor:masterfrom
Conversation
As a user, I found the verbage "matched items" to be rather confusing in the current documentation on the notify callback. It implies that notify is called when a match is found, but it is actually called when a candidate is pushed to the injector
Member
|
The old doc for notify was stored accurate. Whule notify is indeed called when an item was pushed it is also called if the matching exceeded the timeout in Almost all information can update in the background and in that case the notification is triggered |
This file contains hidden or 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
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.
As a user, I found the verbage "matched items" to be rather confusing in the current documentation on the notify callback. It implies that notify is called when a match is found, but it is actually called when a candidate is pushed to the injector