Skip to content

Commit

Permalink
docs: update README.md
Browse files Browse the repository at this point in the history
  • Loading branch information
olimorris committed Feb 5, 2024
1 parent d31a261 commit 13de9d0
Show file tree
Hide file tree
Showing 2 changed files with 14 additions and 9 deletions.
8 changes: 4 additions & 4 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -129,8 +129,8 @@ require("codecompanion").setup({
},
chat = { -- Options for the chat strategy
type = "float", -- float|buffer
show_settings = false, -- Show the model settings in the chat window?
show_token_count = true, -- Show the token count for the current chat?
show_settings = false, -- Show the model settings in the chat buffer?
show_token_count = true, -- Show the token count for the current chat in the buffer?
buf_options = { -- Buffer options for the chat buffer
buflisted = false,
},
Expand Down Expand Up @@ -293,9 +293,9 @@ This action utilises the `author` strategy. This action can be useful for genera

#### 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 output into a chat buffer which follows the `display.chat` settings in your configuration.
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 code to the GenAI may not be an option. In those instances, you can set `send_code = 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.
#### LSP assistant

Expand Down
15 changes: 10 additions & 5 deletions doc/codecompanion.txt
Original file line number Diff line number Diff line change
Expand Up @@ -99,10 +99,13 @@ Click to see the default configuration ~
width = 95,
height = 10,
},
advisor = {
stream = true, -- Stream the output like a chat buffer?
},
chat = { -- Options for the chat strategy
type = "float", -- float|buffer
show_settings = false, -- Show the model settings in the chat window
show_token_count = true, -- Show the token count for the current chat?
show_settings = false, -- Show the model settings in the chat buffer?
show_token_count = true, -- Show the token count for the current chat in the buffer?
buf_options = { -- Buffer options for the chat buffer
buflisted = false,
},
Expand Down Expand Up @@ -310,11 +313,13 @@ 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 output into a
chat buffer which follows the `display.chat` settings in your configuration.
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 code to the GenAI may not be an option.
**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.

LSP ASSISTANT
Expand Down

0 comments on commit 13de9d0

Please sign in to comment.