break out wsh editor and clarify behavior. also document -m flag...#2988
break out wsh editor and clarify behavior. also document -m flag...#2988
wsh editor and clarify behavior. also document -m flag...#2988Conversation
WalkthroughDocumentation updates to wsh-reference.mdx restructure command descriptions for WSH view and edit commands. Added magnified-block aliases for both view and edit commands ( Estimated code review effort🎯 2 (Simple) | ⏱️ ~10 minutes 🚥 Pre-merge checks | ✅ 3✅ Passed checks (3 passed)
✏️ Tip: You can configure your own custom pre-merge checks in the settings. ✨ Finishing Touches🧪 Generate unit tests (beta)
Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out. Comment |
Code Review SummaryStatus: No Issues Found | Recommendation: Merge The documentation changes in this PR are accurate and well-structured. The changes:
The documentation correctly reflects the actual implementation:
Files Reviewed (1 file)
|
![coderabbitai[bot]](https://avatars.githubusercontent.com/in/347564?s=60&v=4){kind=small}
There was a problem hiding this comment.
Actionable comments posted: 1
🤖 Prompt for all review comments with AI agents
Verify each finding against the current code and only fix it if needed.
Inline comments:
In `@docs/docs/wsh-reference.mdx`:
- Line 43: The sentence "blocks until the file is closed" is imprecise; update
the docs entry for `wsh editor` to state that the command blocks until the
editor block is closed (i.e., until the `Event_BlockClose` is received),
matching the implementation in `cmd/wsh/cmd/wshcmd-editor.go` where the code
waits on `Event_BlockClose` (around the wait in lines ~82-89). Mention `wsh
editor` and `Event_BlockClose` explicitly so readers understand the blocking
condition maps to the editor block lifecycle rather than the OS file handle.
ℹ️ Review info
⚙️ Run configuration
Configuration used: Repository UI
Review profile: CHILL
Plan: Pro
Run ID: fa8abec8-e805-4195-a0be-8e1aedf935fb
📒 Files selected for processing (1)
docs/docs/wsh-reference.mdx
| This will open up codeedit for the specified file. This is useful for quickly editing files on a local or remote machine in our graphical editor. This command will wait until the file is closed before exiting (unlike `view`) so you can set your `$EDITOR` to `wsh editor` for a seamless experience. You can combine this with a `-m` flag to open the editor in magnified mode. | ||
| This will open up a codeedit block for the specified file. This is useful for quickly editing files on a local or remote machine in Wave's graphical editor. This command returns immediately after opening the block. | ||
|
|
||
| For `$EDITOR` integration (e.g. with `git commit`), see [`wsh editor`](#editor) which blocks until the file is closed. |
There was a problem hiding this comment.
Tighten wording on blocking condition (Line [43]).
“Blocks until the file is closed” is slightly imprecise. The implementation blocks until the editor block is closed (cmd/wsh/cmd/wshcmd-editor.go, Lines 82-89 waiting on Event_BlockClose).
✏️ Suggested wording tweak
-For `$EDITOR` integration (e.g. with `git commit`), see [`wsh editor`](`#editor`) which blocks until the file is closed.
+For `$EDITOR` integration (e.g. with `git commit`), see [`wsh editor`](`#editor`) which blocks until the editor block is closed.📝 Committable suggestion
‼️ IMPORTANT
Carefully review the code before committing. Ensure that it accurately replaces the highlighted code, contains no missing lines, and has no issues with indentation. Thoroughly test & benchmark the code to ensure it meets the requirements.
| For `$EDITOR` integration (e.g. with `git commit`), see [`wsh editor`](#editor) which blocks until the file is closed. | |
| For `$EDITOR` integration (e.g. with `git commit`), see [`wsh editor`](`#editor`) which blocks until the editor block is closed. |
🤖 Prompt for AI Agents
Verify each finding against the current code and only fix it if needed.
In `@docs/docs/wsh-reference.mdx` at line 43, The sentence "blocks until the file
is closed" is imprecise; update the docs entry for `wsh editor` to state that
the command blocks until the editor block is closed (i.e., until the
`Event_BlockClose` is received), matching the implementation in
`cmd/wsh/cmd/wshcmd-editor.go` where the code waits on `Event_BlockClose`
(around the wait in lines ~82-89). Mention `wsh editor` and `Event_BlockClose`
explicitly so readers understand the blocking condition maps to the editor block
lifecycle rather than the OS file handle.
1 participant
fix documentation issue #2948