Skip to content

Commit

Permalink
commit: update documentation for PromptInputLine
Browse files Browse the repository at this point in the history
  • Loading branch information
mgpinf committed Sep 16, 2024
1 parent b69c7d0 commit c4ccfb4
Showing 1 changed file with 3 additions and 1 deletion.
4 changes: 3 additions & 1 deletion docs/config/lua/keyassignment/PromptInputLine.md
Original file line number Diff line number Diff line change
Expand Up @@ -8,7 +8,7 @@ from the user.
When the user enters the line, emits an event that allows you to act
upon the input.

`PromptInputLine` accepts two fields:
`PromptInputLine` accepts three fields:

* `description` - the text to show at the top of the display area. You may
embed escape sequences and/or use [wezterm.format](../wezterm/format.md).
Expand All @@ -18,6 +18,8 @@ upon the input.
objects from the current pane and window, and `line` is the text that the
user entered. `line` may be `nil` if they hit Escape without entering
anything, or CTRL-C to cancel the input.
* `prompt` - the text to show as the prompt. You may embed escape sequences
and/or use [wezterm.format](../wezterm/format.md). Defaults to: `"> "`

## Example of interactively renaming the current tab

Expand Down

0 comments on commit c4ccfb4

Please sign in to comment.