Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

fix: doc prompt improvements #1198

Merged
merged 16 commits into from
Oct 3, 2023
Merged

fix: doc prompt improvements #1198

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
16 commits
Select commit Hold shift + click to select a range
4836323
Update prompt
toolmantim Sep 27, 2023
3ed0083
Update examples
toolmantim Sep 27, 2023
33e648b
Add some JS test cases
toolmantim Sep 27, 2023
11a967a
Comment
toolmantim Sep 27, 2023
4922436
Add placeholders for Java & Python
toolmantim Sep 27, 2023
2f07910
Lint
toolmantim Sep 27, 2023
0e15a15
Include current file and leave off idiomatic
toolmantim Sep 28, 2023
e66ce07
Update prompt
toolmantim Sep 28, 2023
017d61e
Document the examples
toolmantim Sep 28, 2023
08de391
Changelog
toolmantim Sep 28, 2023
a804ad8
Lint
toolmantim Sep 28, 2023
a90527a
Merge branch 'main' into tl/update-doc-prompt
toolmantim Sep 29, 2023
d81ef69
Merge branch 'main' into tl/update-doc-prompt
toolmantim Oct 2, 2023
cfa51c9
Update CHANGELOG.md
toolmantim Oct 2, 2023
99ebae7
Always prevent markdown
toolmantim Oct 3, 2023
fcab73f
Merge branch 'main' into tl/update-doc-prompt
abeatrix Oct 3, 2023
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 1 addition & 1 deletion lib/shared/src/chat/prompts/cody.json
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@
"commands": {
"doc": {
"description": "Generate code documentation",
"prompt": "Write a brief documentation comment for the selected code. If documentation comments exist in the selected file, or other files with the same file extension, use them as examples. Pay attention to the scope of the selected code (e.g. exported function/API vs implementation detail in a function), and use the idiomatic style for that type of code scope. Only generate the documentation for the selected code, do not generate the code. Do not output any other code or comments besides the documentation.",
"prompt": "Write a brief documentation comment for the selected code. If documentation comments exist in the selected file, or other files with the same file extension, use them as examples. Pay attention to the scope of the selected code (e.g. exported function/API vs implementation detail in a function), and use the idiomatic style for that type of code scope. Only generate the documentation for the selected code, do not generate the code. Do not output any other code or comments besides the documentation. Output only the comment and do not enclose it in markdown.",
toolmantim marked this conversation as resolved.
Show resolved Hide resolved
"context": {
"currentFile": true,
"currentDir": true,
Expand Down
3 changes: 2 additions & 1 deletion vscode/CHANGELOG.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -18,7 +18,8 @@ Starting from `0.2.0`, Cody is using `major.EVEN_NUMBER.patch` for release versi

### Fixed

- Remove chat and chat history created by edit and doc commands. [pull/1220](https://github.com/sourcegraph/cody/pull/1220)
- Improved quality of documentation created by the `/doc` command. [pull/1198](https://github.com/sourcegraph/cody/pull/1198)
- Removed chat and chat history created by `/edit` and `/doc` commands. [pull/1220](https://github.com/sourcegraph/cody/pull/1220)
- Only show "Ask Cody Inline" context menu item when signed in. [pull/1281](https://github.com/sourcegraph/cody/pull/1281)

### Changed
Expand Down