Skip to content

update notify docstrings to be more clear #78

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

Open
wants to merge 1 commit into
base: master
Choose a base branch
from

Conversation

joe-p
Copy link

@joe-p joe-p commented Apr 29, 2025

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

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
@pascalkuthe
Copy link
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 tick and has finished in the background. There are also other things that can trigger this. The list is intentionality not exhaustive.

Almost all information can update in the background and in that case the notification is triggered

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants