Port PR #4084 to release/7.0: Fix API docs and doc include paths#4107
Merged
Conversation
Agent-Logs-Url: https://github.com/dotnet/SqlClient/sessions/1d30e5d6-ae83-4523-9c05-2e7b15d13480 Co-authored-by: apoorvdeshmukh <5858671+apoorvdeshmukh@users.noreply.github.com>
…lJson.cs, SqlVector.cs (from PR #4033) Agent-Logs-Url: https://github.com/dotnet/SqlClient/sessions/1d30e5d6-ae83-4523-9c05-2e7b15d13480 Co-authored-by: apoorvdeshmukh <5858671+apoorvdeshmukh@users.noreply.github.com>
Copilot created this pull request from a session on behalf of
apoorvdeshmukh
March 31, 2026 15:19
View session
apoorvdeshmukh
added
the
Area\Documentation
Contributor
There was a problem hiding this comment.
Pull request overview
Ports doc-generation fixes from PR #4084 onto release/7.0 to resolve broken API doc includes and improve DocFX/XML output for several SqlClient APIs (notably JSON and vector types).
Changes:
- Fixed
<include file='...'>relative paths in source to correctly referencedoc/snippetsfrom the unifiedsrc/tree (SqlDataReader, SqlJson, SqlVector, SqlDbTypeExtensions). - Cleaned up snippet XML formatting (whitespace/trailing spaces) and corrected a few xref targets (generic
SqlVector<T>and retry-logic generic method xrefs; DataAdapter event xrefs).
Reviewed changes
Copilot reviewed 7 out of 7 changed files in this pull request and generated no comments.
Show a summary per file
| File | Description |
|---|---|
| src/Microsoft.Data.SqlClient/src/Microsoft/Data/SqlTypes/SqlVector.cs | Adjusts doc snippet include paths to the correct repo-relative location. |
| src/Microsoft.Data.SqlClient/src/Microsoft/Data/SqlTypes/SqlJson.cs | Adjusts doc snippet include paths to the correct repo-relative location. |
| src/Microsoft.Data.SqlClient/src/Microsoft/Data/SqlDbTypeExtensions.cs | Adjusts doc snippet include paths to the correct repo-relative location. |
| src/Microsoft.Data.SqlClient/src/Microsoft/Data/SqlClient/SqlDataReader.cs | Adjusts doc snippet include paths for GetSqlJson / GetSqlVector. |
| doc/snippets/Microsoft.Data.SqlClient/SqlDataReader.xml | Formatting cleanup + fixes SqlVector xrefs to the generic type (SqlVector\1`). |
| doc/snippets/Microsoft.Data.SqlClient/SqlDataAdapter.xml | Formatting cleanup + changes references to RowUpdating/RowUpdated to event xrefs. |
| doc/snippets/Microsoft.Data.SqlClient/SqlCommand.xml | Formatting cleanup + fixes DocFX xrefs for generic retry-logic methods and SqlVector<T> references. |
Closed
Codecov Report✅ All modified and coverable lines are covered by tests.
Additional details and impacted files@@ Coverage Diff @@
## release/7.0 #4107 +/- ##
===============================================
- Coverage 73.07% 65.58% -7.50%
===============================================
Files 280 275 -5
Lines 42997 65822 +22825
===============================================
+ Hits 31422 43168 +11746
- Misses 11575 22654 +11079
Flags with carried forward coverage won't be shown. Click here to find out more. ☔ View full report in Codecov by Sentry. 🚀 New features to boost your workflow:
|
apoorvdeshmukh
approved these changes
Apr 1, 2026
mdaigle
approved these changes
Apr 2, 2026
paulmedynski
approved these changes
Apr 6, 2026
This was referenced Apr 24, 2026
This was referenced May 22, 2026
This was referenced May 30, 2026
Closed
This was referenced Jun 7, 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.
../../../../to../../../../../../../../../../to../../../../../../../../../to../../../../../../../../../../to../../../../../../