From 65d41cca1380a5c35931a953a4900c505591e725 Mon Sep 17 00:00:00 2001 From: Tibor Schmidt Date: Wed, 17 Jul 2024 15:56:24 +0200 Subject: [PATCH] docs: update README.md --- README.md | 5 +++-- 1 file changed, 3 insertions(+), 2 deletions(-) diff --git a/README.md b/README.md index 43e925e..a218b05 100644 --- a/README.md +++ b/README.md @@ -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: @@ -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)