Skip to content

Document "puff", "float" and "drop" #2877

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.

Sign up for GitHub

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

Merged
merged 2 commits into from
Mar 29, 2025
Merged

Document "puff", "float" and "drop" #2877

Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
55f936d
Document `"puff"`, `"float"` and `"drop"`
pokey Mar 23, 2025
6ef1b01
Merge branch 'main' into pokey/document-puff-float-and-drop
AndreasArvidsson Mar 29, 2025
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
9 changes: 7 additions & 2 deletions packages/cursorless-org-docs/src/docs/user/README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -620,14 +620,19 @@ For example:

- `"drink <TARGET>"`: Inserts a new line above the target line, and moves the cursor to the newly created line
- `"pour <TARGET>"`: Inserts a new line below the target line, and moves the cursor to the newly created line
- `"drop <TARGET>"`: Inserts an empty line above the target line (without moving the cursor)
- `"float <TARGET>"`: Inserts an empty line below the target line (without moving the cursor)
- `"puff <TARGET>"`: Inserts empty lines/spaces around the target (without moving the cursor)

eg: `pour blue air` will insert empty line below the token containing letter 'a' with a blue hat and moves the cursor to the new line.

Note: `"drink"` and `"pour"` are actually a bit more versatile than just lines.
If you use a [syntactic scope](#syntactic-scopes) modifier on the target, then`"drink"` and `"pour"` will do the
Note: `"drink"`, `"pour"`, `"drop"`, `"float"`, and `"puff"` are actually more versatile than just handling lines.
If you use a [syntactic scope](#syntactic-scopes) modifier on the target, they will do the
appropriate insertions to prepare the text for a new instance of that scope.

eg: `pour item air` will insert a comma and space after the air item, and place the cursor after the inserted characters.
eg: `puff token air` will insert spaces around the token with a hat over the letter 'a'.
eg: `float item air` will insert a comma after the item containing letter 'a' with a hat.

### Homophones

Expand Down
Loading