Auto-edit docs #899
Merged
Auto-edit docs #899
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
|
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 |
sagtanih
requested changes
Jan 15, 2025
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 )
- 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.
| @@ -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
This change replaces the static image demonstrating the auto-edit feature with an embedded video, providing a more dynamic and engaging visual representation for users.
|
@jdorfman can you please take care of these changes? |
This change adds two additional steps to the instructions for enabling the auto-edit feature for Cody Enterprise customers. Specifically, it requires site administrators to allow the Fireworks provider as an allowed provider, in addition to enabling the feature flag
This change removes the "Scope" row from the comparison table between auto-edit and autocomplete features, as the information was redundant and not providing additional value.
This change expands the description of the auto-edit feature, providing more detailed information about the various repetitive tasks it can assist with, including: - Function signature refactoring - Updating function call sites after signature changes - Repetitive modifications in test files - Parameter additions and function unpacking - Type system updates across multiple locations
This change removes the requirement for at least one character edit in the codebase before auto-edit suggestions become active. This simplifies the user experience and allows the feature to provide suggestions immediately upon enabling.
graceshih-sg
approved these changes
Jan 28, 2025
aramaraju
suggested changes
Jan 29, 2025
…ind) This change expands the description of the auto-edit feature, providing more detailed information about the various repetitive tasks it can assist with, including: - Test file maintenance - Parameter refactoring - Type system modifications
aramaraju
approved these changes
Jan 29, 2025
…owed LLM provider (via Aravind) This change adds a new section to the auto-edit feature documentation that provides an example of how to configure Fireworks as an allowed LLM provider in the Sourcegraph Cody Gateway model configuration. This allows users to utilize Fireworks models for the auto-edit feature.
|
Thanks everyone for contributing. I am merging this PR to our release branch. Any follow-up changes will be tackled later after the release. Let's go! 🚀 |
sagtanih
reviewed
Jan 29, 2025
| | ---------------------- | -------------------------------------- | -------------------------------------------------- | | ||
| | **Text modification** | Can only insert text, not delete | Can both insert and delete text | | ||
| | **Cursor position** | Only proposes content after the cursor | Can modify code before and after the cursor | | ||
| | **Suggestion trigger** | Suggests on every character typed | Proposes changes based on context and recent edits | |
There was a problem hiding this comment.
Thanks for the amazing doc @MaedahBatool
I just noticed this section, I think Suggestion trigger for Auto-edit should be every char typed + Cursor movement within the codebase. Since based on context and recent edits are just the context sources which we use in the autocomplete as well.
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Docs for auto-edit