Skip to content

Update docs to clarify that all actions require a target #456

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

Closed
Tracked by #840
pokey opened this issue Dec 1, 2021 · 3 comments · Fixed by #628
Closed
Tracked by #840

Update docs to clarify that all actions require a target #456

pokey opened this issue Dec 1, 2021 · 3 comments · Fixed by #628
Labels
documentation Improvements or additions to documentation help wanted Extra attention is needed talon Related to cursorless-talon
Milestone

Comments

@pokey
Copy link
Member

pokey commented Dec 1, 2021

We've had users try to say just "crown" or "square wrap" without a target and wonder why it won't parse. We could support these commands, but worry that they would pollute the command space when you can just say eg "crown this" instead. For the time being, we'll

  • improve the docs to make it clearer that these actions without targets aren't possible
  • modify the cheatsheet so that every action has a T after it for consistency
@pokey pokey transferred this issue from cursorless-dev/cursorless-talon Jan 12, 2022
@pokey pokey added documentation Improvements or additions to documentation talon Related to cursorless-talon help wanted Extra attention is needed labels Jan 12, 2022
@pokey pokey added this to the On deck milestone Jan 18, 2022
@AndrewDant
Copy link
Collaborator

image

To be honest I think it looks a bit uglier with the T after every action, but on the other hand I have made this same mistake so it might well be worth it.

@AndrewDant
Copy link
Collaborator

I'm willing to take this on. As far as adding examples go would you prefer if I use a variety of different targets as examples or if I stick to the same example that appears a lot throughout the existing docks (' blue air')?

@AndrewDant
Copy link
Collaborator

Actually most things have an example already, I just happened to look at change first which does not.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation Improvements or additions to documentation help wanted Extra attention is needed talon Related to cursorless-talon
Projects
None yet
Development

Successfully merging a pull request may close this issue.

2 participants