diff --git a/README.md b/README.md index 54b77f13..b4180c08 100644 --- a/README.md +++ b/README.md @@ -40,7 +40,7 @@ Use the

Chat bufferchat buffer

-

Code authorcode author

+

Code authorcode author

Code advisorcode advisorcode advisor

@@ -307,16 +307,16 @@ Both of these actions utilise the `chat` strategy. The `Chat` action opens up a This action enables users to easily navigate between their open chat buffers. A chat buffer maybe deleted (and removed from this action) by pressing `` when in the chat buffer. +#### Code author + +This action utilises the `author` strategy. This action can be useful for writing code into a buffer or even refactoring a visual selection; all based on a user's prompt. The action is designed to write code for the buffer filetype that it is initated in, or, if run from a terminal prompt, to write commands. + #### Code advisor As the name suggests, this action provides advice on a visual selection of code and utilises the `advisor` strategy. The response from the API is streamed into a chat buffer which follows the `display.chat` settings in your configuration. If you wish to turn the streaming off, set `display.advisor.stream = false` in your config. > **Note**: For some users, the sending of any code to an LLM may not be an option. In those instances, you can set `send_code = false` in your config. -#### Code author - -This action utilises the `author` strategy. This action can be useful for generating code or even refactoring a visual selection based on a prompt by the user. The action is designed to write code for the buffer filetype that it is initated in, or, if run from a terminal prompt, to write commands. - #### LSP assistant Taken from the fantastic [Wtf.nvim](https://github.com/piersolenski/wtf.nvim) plugin, this action provides advice (utilising the `advisor` strategy) on any LSP diagnostics which occur across visually selected lines and how they can be fixed. Again, the `send_code = false` value can be set in your config to only send diagnostic messages to OpenAI. diff --git a/doc/codecompanion.txt b/doc/codecompanion.txt index b09613a9..f0920f77 100644 --- a/doc/codecompanion.txt +++ b/doc/codecompanion.txt @@ -322,6 +322,14 @@ chat buffer maybe deleted (and removed from this action) by pressing `` when in the chat buffer. +CODE AUTHOR + +This action utilises the `author` strategy. This action can be useful for +writing code into a buffer or even refactoring a visual selection; all based on +a user’s prompt. The action is designed to write code for the buffer filetype +that it is initated in, or, if run from a terminal prompt, to write commands. + + CODE ADVISOR As the name suggests, this action provides advice on a visual selection of code @@ -334,14 +342,6 @@ your config. **Note**For some users, the sending of any code to an LLM may not be an option. In those instances, you can set `send_code = false` in your config. -CODE AUTHOR - -This action utilises the `author` strategy. This action can be useful for -generating code or even refactoring a visual selection based on a prompt by the -user. The action is designed to write code for the buffer filetype that it is -initated in, or, if run from a terminal prompt, to write commands. - - LSP ASSISTANT Taken from the fantastic Wtf.nvim