Document TAB edit and ENTER execute functionality #524
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
There was a problem hiding this comment.
Pull Request Overview
This PR enhances the documentation in the README to clarify the behavior of TAB and ENTER keys for command editing and execution in HSTR.
- Adds explicit instruction for editing commands with TAB and executing them with ENTER
- Improves user guidance by contrasting with the default Ctrl‑R behavior
|
|
||
| HSTR (**H**i**ST**o**R**y) is a command line utility that brings improved `bash`/`zsh` command completion | ||
| from the history. It aims to make completion **easier** and more **efficient** than <kbd>Ctrl-r</kbd>. | ||
| from the history. It aims to make completion **easier** and more **efficient** than <kbd>Ctrl-r</kbd>. Press <kbd>TAB</kbd> to edit a selected command and <kbd>ENTER</kbd> to execute it directly. |
There was a problem hiding this comment.
[nitpick] The new instruction improves clarity, but consider adjusting the sentence structure for enhanced readability and parallelism between key instructions.
Suggested change
| from the history. It aims to make completion **easier** and more **efficient** than <kbd>Ctrl-r</kbd>. Press <kbd>TAB</kbd> to edit a selected command and <kbd>ENTER</kbd> to execute it directly. | |
| from the history. It aims to make completion both **easier** and **more efficient** than <kbd>Ctrl-r</kbd>. Press <kbd>TAB</kbd> to edit a selected command and <kbd>ENTER</kbd> to execute it directly. |
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
1 participant
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
I was initially unaware that the default Ctrl+R functionality allowed for command editing, which made the use of TAB for editing within HSTR non-intuitive for me. Consequently, I had to spend some time examining the source code to discover that commands could be edited instead of being executed immediately.