Skip to content

Commit

Permalink
Document commandine --showing-suggestion
Browse files Browse the repository at this point in the history
  • Loading branch information
mqudsi committed Jun 27, 2024
1 parent a7c7e33 commit 975a7b9
Showing 1 changed file with 4 additions and 0 deletions.
4 changes: 4 additions & 0 deletions doc_src/cmds/commandline.rst
Original file line number Diff line number Diff line change
Expand Up @@ -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
-------

Expand Down

0 comments on commit 975a7b9

Please sign in to comment.