github-mirror/fish-shell
2
0
Fork 0
mirror of https://github.com/fish-shell/fish-shell.git synced 2024-11-22 13:57:17 +08:00
Code Issues Actions Packages Projects Releases Wiki Activity

Document commandine --showing-suggestion

Browse Source
This commit is contained in:
Mahmoud Al-Qudsi 2024-06-26 21:53:51 -05:00
parent faf3b356f2
commit b93e52079b
1 changed files with 4 additions and 0 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

4
doc_src/cmds/commandline.rst
View File

@ -113,6 +113,10 @@ The following options output metadata about the commandline state:
If it is, it would be executed when the ``execute`` bind function is called.
If the commandline is incomplete, return 2, if erroneus, return 1.
**--showing-suggestion**
Evaluates to true (i.e. returns 0) when the shell is currently showing an automatic history completion/suggestion, available to be consumed via one of the `forward-` bindings.
For example, can be used to determine if moving the cursor to the right when already at the end of the line would have no effect or if it would cause a completion to be accepted (note that `forward-char-passive` does this automatically).
Example
-------