Update cursorless reference, help terms and docs #599
Conversation
- Ultimately would like to make some of the terms configurable but this has already helped me trigger the cheatsheet without as any error. - Triggering "docs" in .talon looks like a cludge to me
|
I think this PR is still a win, esp if the docs immediately tell you how to use the cheatsheet for those who were expecting old "cursorless help" behaviour |
cursorless-talon/src/term.py
Outdated
| CURSORLESS_WINDOW_TRIGGER = "(cursorless | cursor list | cursor less)" | ||
|
|
||
|
|
||
| @mod.capture(rule=CURSORLESS_WINDOW_TRIGGER) | ||
| def cursorless_window_trigger(m) -> str: | ||
| """Term to trigger cursorless help functions in talon""" | ||
| return str(m) |
There was a problem hiding this comment.
why not just use a talon list here?
There was a problem hiding this comment.
I would definitely prefer a talon list. Works better with future csv implementation aswell.
| <user.cursorless_window_trigger> reference: user.cursorless_cheat_sheet_toggle() | ||
| reference <user.cursorless_window_trigger>: user.cursorless_cheat_sheet_toggle() |
There was a problem hiding this comment.
I don't think we need the reverse format for reference. Help is one thing because it needs to be easy to find for beginners. I think that when you reach the level where you use the references you should be able to remember the command.cp
|
I think we should probably add these commands to a csv file. |
|
this one is waiting on #884 |
pokey
added
the
blocked
pokey
force-pushed
the
451-update-help
branch
from
cf4c7a8 to
4f5ab4b
Compare
pokey
force-pushed
the
451-update-help
branch
from
4f5ab4b to
93bea1b
Compare
| app.notify( | ||
| 'Please first focus an app that supports cursorless, eg say "focus code"' | ||
| ) |
There was a problem hiding this comment.
This seems like better UX than Talon just refusing to hear them when they say "cursorless cheatsheet" in the wrong place
|
|
||
| def cursorless_open_instructions(): | ||
| """Open web page with cursorless instructions""" | ||
| webbrowser.open(instructions_url) |
There was a problem hiding this comment.
no reason not to support this everywhere. This way if user first installs Cursorless and says "cursorless help", they'll get the docs no matter what
| def cursorless_open_instructions(): | ||
| """Open web page with cursorless instructions""" | ||
| webbrowser.open(instructions_url) | ||
| def cursorless_cheat_sheet_get_json(): |
There was a problem hiding this comment.
Move to local function rather than action, per discussion today
| @@ -0,0 +1,3 @@ | |||
| {user.cursorless_homophone} (reference | ref | cheatsheet | cheat sheet): user.cursorless_cheat_sheet_show_html() | |||
There was a problem hiding this comment.
Make all these active globally, though the cheatsheet just shows a helpful message, per above
pokey
removed
the
blocked
What
Addresses notes in this issue #451. After using it just for a few minutes on my branch, its been really help as it avoids collision with knausj
"curse"commands.Other thoughts:
has already helped me trigger the cheatsheet without as any error.
Questions:
Checklist