Skip to content

Commit

Permalink
docs: update README.md
Browse files Browse the repository at this point in the history
  • Loading branch information
Robitx authored Jul 17, 2024
1 parent a6eb46e commit 65d41cc
Showing 1 changed file with 3 additions and 2 deletions.
5 changes: 3 additions & 2 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -798,7 +798,7 @@ The raw plugin text editing method `Prompt` has following signature:
---@param prompt string | nil # nil for non interactive commads
---@param whisper string | nil # predefined input (e.g. obtained from Whisper)
---@param callback function | nil # callback(response) after completing the prompt
Prompt(params, target, agent, template, prompt, whisper)
Prompt(params, target, agent, template, prompt, whisper, callback)
```

- `params` is a [table passed to neovim user commands](https://neovim.io/doc/user/lua-guide.html#lua-guide-commands-create), `Prompt` currently uses:
Expand Down Expand Up @@ -911,4 +911,5 @@ Prompt(params, target, agent, template, prompt, whisper)
- `whisper`
- optional string serving as a default for input prompt (for example generated from speech by Whisper)
- `callback`
- optional callback function receiving the prompt response
- optional callback function allowing post processing logic on the prompt response
(for example letting the model to generate commit message and using the callback to make actual commit)

0 comments on commit 65d41cc

Please sign in to comment.