doc: Be clear that add_hotkey is not sufficient #357
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
Clarify that you need to wait to keep the script active so it can listen to hotkeys (it does not spawn a process in the background that will wait for them). The line "For an example of how to use a callback synchronously, see `wait`." indicates that `wait` is an alternative to add_hotkey and a helpful way to use it. wait seems to be a better alternative to `while True: pass`. I found it difficult to figure out how to write a script that just waits for hotkeys, and this addition would have helped me.
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.
Clarify that you need to wait to keep the script active so it can listen
to hotkeys (it does not spawn a process in the background that will wait
for them).
The line "For an example of how to use a callback synchronously, see
wait." indicates thatwaitis an alternative to add_hotkey and ahelpful way to use it.
wait seems to be a better alternative to
while True: pass.I found it difficult to figure out how to write a script that just waits
for hotkeys, and this addition would have helped me.