Skip to content

Commit

Permalink
update documentation for PromptInputLine
Browse files Browse the repository at this point in the history
This adds prompt argument information to the documentation
  • Loading branch information
mgpinf committed Aug 28, 2024
1 parent 354e2c7 commit 50f4cee
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,10 +8,12 @@ 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).
* `prompt` - the text to show as the prompt. You may embed escape sequences
and/or use [wezterm.format](../wezterm/format.md). Defaults to: `"> "`
* `action` - and event callback registerd via `wezterm.action_callback`. The
callback's function signature is `(window, pane, line)` where `window` and
`pane` are the [Window](../window/index.md) and [Pane](../pane/index.md)
Expand Down

0 comments on commit 50f4cee

Please sign in to comment.