Port PR #4084 to release/7.0: Fix API docs and doc include paths#4107
Port PR #4084 to release/7.0: Fix API docs and doc include paths#4107paulmedynski merged 2 commits intorelease/7.0from
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>
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. |
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:
|
../../../../to../../../../../../../../../../to../../../../../../../../../to../../../../../../../../../../to../../../../../../