Skip to content

Commit beee7c1

Browse files
authored
Document "visible" modifier in user docs (#3171)
## Summary - Adds documentation for the `"visible"` modifier to the user reference (README.md), between `"file"` and `"head"`/`"tail"` - The modifier was added in #2094 and appears in the cheatsheet, but was never documented in prose Fixes #2869 ## Test plan - [ ] Verify the docs site renders correctly (`pnpm -F cursorless-org dev`)
1 parent eebd7f8 commit beee7c1

1 file changed

Lines changed: 9 additions & 0 deletions

File tree

  • packages/cursorless-org-docs/src/docs/user

‎packages/cursorless-org-docs/src/docs/user/README.md‎

Lines changed: 9 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -305,6 +305,15 @@ The word '`"file"` can be used to expand the target to refer to the entire file.
305305

306306
For example, `"take file [blue] air"` selects the file including the token containing letter 'a' with a blue hat.
307307

308+
##### `"visible"`
309+
310+
The word `"visible"` refers to the currently visible content in the editor viewport, excluding any folded/collapsed regions.
311+
312+
- `"take visible"`
313+
- `"chuck visible"`
314+
315+
This is useful for limiting operations to what's on screen. For example, `"from visible take every instance air"` will only match visible instances of the token with an 'a' hat, skipping matches hidden in folded regions or scrolled out of view.
316+
308317
##### `"head"` and `"tail"`
309318

310319
The modifiers `"head"` and `"tail"` can be used to expand a target through the beginning or end of the line, respectively.

0 commit comments

Comments
 (0)