Generate Documentation - incorrect buffer bug - #84709
Merged
Merged
Conversation
Co-authored-by: Copilot Autofix powered by AI <175728472+Copilot@users.noreply.github.com>
|
Azure Pipelines: Successfully started running 2 pipeline(s). There may be pipelines that require an authorized user to comment /azp run to run. |
Contributor
There was a problem hiding this comment.
Pull request overview
Fixes a buffer-mismatch bug in the Copilot “Generate Documentation” flow by ensuring documentation edits are applied to the same ITextBuffer that the captured ITextSnapshot came from, avoiding span translation failures in projection-buffer scenarios.
Changes:
- Remove the
ITextViewparameter fromGenerateAndApplyDocumentationAsyncsince it’s no longer needed for applying edits. - Apply generated documentation edits using
snapshot.TextBufferinstead oftextView.TextBufferto keep span translation within the same buffer.
Show a summary per file
| File | Description |
|---|---|
| src/EditorFeatures/Core/DocumentationComments/CopilotGenerateDocumentationCommentManager.cs | Applies documentation edits to the snapshot’s buffer to prevent cross-buffer span translation failures (notably in projection scenarios). |
Copilot's findings
- Files reviewed: 1/1 changed files
- Comments generated: 1
jasonmalinowski
approved these changes
Jul 30, 2026
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
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.
ApplyDocumentationEditsAsyncis invoked withtextView.TextBuffer, but the edit spans are based on the snapshot passed in (captured from the subject buffer in the command handler). In projection scenarios these buffers can differ, and translating spans across snapshots from different buffers will fail. Use the buffer associated with the captured snapshot when applying edits.Microsoft Reviewers: Open in CodeFlow