Skip to content

Commit 36506e8

Browse files
committed
doc: better builtin command usage
1 parent 70ddb84 commit 36506e8

File tree

2 files changed

+26
-21
lines changed

2 files changed

+26
-21
lines changed

README.md

Lines changed: 11 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -84,7 +84,7 @@ The top-level command is `:Chat`. The behavior is different depending on whether
8484

8585
### Completion
8686

87-
* `:Chat` with text selection will trigger the `completion` command, ChatGPT will try to complete the selected code snippet.
87+
* `:Chat` with text selection will trigger the `completion` command, LLM will try to complete the selected code snippet.
8888
<div align="center">
8989
<p>
9090
<video controls muted src="https://github.com/user-attachments/assets/1c26404e-5c3b-4729-ba03-83454c53de91"></video>
@@ -154,15 +154,16 @@ Here is the full list of predefined command actions:
154154

155155
| command | input | Description |
156156
|--------------|---- |------------------------------------|
157-
| completion | text selection | Will ask ChatGPT to complete the selected code. |
158-
| code_edit | text selection + command args | Will ask ChatGPT to apply the given instructions (the command args) to the selected code. |
159-
| explain | text selection | Will ask ChatGPT to explain the selected code. |
160-
| question | text selection | Will pass the commands args to ChatGPT and return the answer in a text popup. |
161-
| debug | text selection | Will pass the code selection to ChatGPT analyze it for bugs, the results will be in a text popup. |
162-
| doc | text selection | Will ask ChatGPT to document the selected code. |
163-
| opt | text selection | Will ask ChatGPT to optimize the selected code. |
164-
| tests | text selection | Will ask ChatGPT to write unit tests for the selected code. |
165-
| chat | command args | Will pass the given command args to ChatGPT and return the response in a popup. |
157+
| completion | selection | Will ask LLM to complete the selected code. |
158+
| code_edit | selection [ + args ] | Will ask LLM to apply the given instructions (the command args) to the selected code. |
159+
| explain | selection | Will ask LLM to explain the selected code. |
160+
| question | selection + args | Will pass the commands args to LLM and return the answer in a text popup. |
161+
| debug | selection | Will pass the code selection to LLM analyze it for bugs, the results will be in a text popup. |
162+
| doc | selection | Will ask LLM to document the selected code. |
163+
| opt | selection | Will ask LLM to optimize the selected code. |
164+
| tests | selection + args | Will ask LLM to write unit tests for the selected code. |
165+
| chat | args | Will pass the given command args to LLM and return the response in a popup. |
166+
| proofread | selection [ + args ] | Asks LLM to review the provided code selection/buffer. |
166167

167168
## Configuration
168169

doc/codegpt.txt

Lines changed: 15 additions & 11 deletions
Original file line numberDiff line numberDiff line change
@@ -142,37 +142,41 @@ Here is the full list of predefined command actions grouped by the input type
142142
commands ~
143143

144144
completion input type: text selection
145-
Will ask ChatGPT to complete the selected code.
145+
Will ask LLM to complete the selected code.
146146

147-
code_edit input type: text selection + arguments
148-
Will ask ChatGPT to apply the given instructions (the
147+
code_edit input type: text selection [ + arguments ]
148+
Will ask LLM to apply the given instructions (the
149149
command args) to the selected code.
150150

151151
explain input type: text selection
152-
Will ask ChatGPT to explain the selected code.
152+
Will ask LLM to explain the selected code.
153153

154154
question input type: text selection + arguments
155-
Will pass the commands args to ChatGPT and return the
155+
Will pass the commands args to LLM and return the
156156
answer in a text popup.
157157

158158
debug input type: text selection
159-
Will pass the code selection to ChatGPT analyze it for
159+
Will pass the code selection to LLM analyze it for
160160
bugs, the results will be in a text popup.
161161

162162
doc input type: text selection
163-
Will ask ChatGPT to document the selected code.
163+
Will ask LLM to document the selected code.
164164

165165
opt input type: text selection
166-
Will ask ChatGPT to optimize the selected code.
166+
Will ask LLM to optimize the selected code.
167167

168-
tests input type: text selection
169-
Will ask ChatGPT to write unit tests for the selected
168+
tests input type: text selection [ + arguments ]
169+
Will ask LLM to write unit tests for the selected
170170
code.
171171

172172
chat input type: command args
173-
Will pass the given command args to ChatGPT and return
173+
Will pass the given command args to LLM and return
174174
the response in a popup.
175175

176+
proofread input type: text selection [ + arguments ]
177+
Ask LLM to review the selected snippet/buffer.
178+
179+
176180
USING RANGE MODIFIER *codegpt-commands-range*
177181

178182
You can use the `:%` range modifier `%<COMMAND>` to call a

0 commit comments

Comments
 (0)