Auto-edits docs #899
Auto-edits docs #899
Conversation
|
The latest updates on your projects. Learn more about Vercel for Git ↗︎
|
- Add a subtitle and description for the auto-edits feature - Outline the capabilities of auto-edits - Provide guidance on enabling auto-edits for Enterprise customers - Explain how auto-edits work and how they differ from autocomplete - List common use cases for auto-edits - Acknowledge known limitations of the feature
|
Slack discussion: https://sourcegraph.slack.com/archives/C07F8LLKE06/p1736971866958289 |
There was a problem hiding this comment.
Found some duplication in the docs and added some additional comments. Some additional points:
- Should we have some videos on the page to highlight the feature in action
- we should mention that auto-edits can Conflict in decorations when used with other code suggestions extensions enabled. it is recommended to disable other extensions.
- We should add a section mentioning how users can disable the feature from vscode settings. (Also why certain users might not be able to use it even though they are able to select auto-edit option in the UI )
|
|
||
| - Can modify code before and after the cursor position | ||
|
|
||
| - Proposes changes based on context and recent edits |
There was a problem hiding this comment.
It uses a bunch of other context sources. I think we can highlight that recent edits is important but not the only context source.
There was a problem hiding this comment.
It uses a bunch of other context sources.
Tell me :)
|
|
||
| - Sometimes doesn't propose all necessary changes | ||
|
|
||
| - May require manual deletion in some cases |
There was a problem hiding this comment.
not sure if I understand this correctly, is this overlapping with "Sometimes doesn't propose all necessary changes"
|
|
||
| - May require manual deletion in some cases | ||
|
|
||
| - Certain changes may need to be applied manually |
There was a problem hiding this comment.
not sure what this mean, can you please give more details here ?
There was a problem hiding this comment.
@hitesh-1997 these where pulled from the Loom video transcript, I will work on rewording them for clarity
- Update the subtitle and description for the auto-edits feature - Clarify the capabilities of auto-edits - Provide guidance on enabling auto-edits for Pro and Enterprise customers - Explain how auto-edits differ from autocomplete - List common use cases for auto-edits - Acknowledge known limitations of the feature
|
|
||
| - Only proposes content after the cursor position | ||
|
|
||
| - Suggests on every character typed |
There was a problem hiding this comment.
Only proposes content after the cursor position
There's also a limitation from the VS Code API: our autocomplete can only suggest content after the cursor position on the current line. So, if the model proposes an insertion into the middle or end of the following line, we don't have a way to render it. There's no such limitation for auto-edit.
|
|
||
| - Requires at least one character edit in the codebase before suggestions become active | ||
| - May not propose all necessary changes in complex refactoring scenarios, requiring some manual edits | ||
| - Sometimes requires manual deletion or cleanup of code |
There was a problem hiding this comment.
I'd say this isn't necessary. It's an inherent property of LLM-generated code these days.
There was a problem hiding this comment.
line 75 "- Sometimes requires manual deletion or cleanup of code" or all lines listed?
| @@ -0,0 +1,89 @@ | |||
| # Auto-edits | |||
There was a problem hiding this comment.
Ah, Hitesh already caught it 👍
Co-authored-by: Valery Bugakov <[email protected]>
- Update the feature name from "Auto-edits" to "Auto-edit" throughout the documentation - Adjust the subtitle and description to reflect the singular "Auto-edit" name - Update the section headings and references to use the singular "Auto-edit" terminology
- Add an auto-edit demo image to the documentation - Include a note indicating the image needs to be uploaded to GCP
- Provide details on how Enterprise customers can enable the auto-edit feature - Explain the two-step process required to make auto-edit available to developers
- Clarify that Auto-edit suggestions are limited to a fixed number of lines around the cursor - Document that Auto-edit may not propose all necessary changes in complex refactoring scenarios - Explain that manual deletion or cleanup of code may still be required in some cases - Note that Auto-edit suggestions may not cover all similar instances of code that could be changed
Docs for autoedits