[6.1] Fix API docs #3533
Merged
[6.1] Fix API docs #3533
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
Contributor
There was a problem hiding this comment.
Pull Request Overview
This PR fixes API documentation references for the SqlVector type by updating XML documentation to use the correct generic type notation. The changes address documentation warnings related to incorrect type references.
Key changes:
- Updates XML documentation references from
SqlVectortoSqlVector1` to properly reference the generic type - Fixes type references in method summaries, return descriptions, and exception documentation
Reviewed Changes
Copilot reviewed 2 out of 2 changed files in this pull request and generated 1 comment.
| File | Description |
|---|---|
| doc/snippets/Microsoft.Data.SqlClient/SqlDataReader.xml | Updates GetSqlVector method documentation to use correct generic type reference |
| doc/snippets/Microsoft.Data.SqlClient/SqlCommand.xml | Fixes SqlVector type reference in Prepare method documentation |
apoorvdeshmukh
approved these changes
Jul 31, 2025
mdaigle
approved these changes
Jul 31, 2025
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.
Addresses #3532
The doc warnings in SqlDataAdapter class are not addressed here, as those methods are missing from generated docs. Following up internally on those warnings.