Skip to content

Port PR #4084 to release/7.0: Fix API docs and doc include paths#4107

Merged
paulmedynski merged 2 commits intorelease/7.0from
copilot/port-pr-4084-to-release-7-0
Apr 6, 2026
Merged

Port PR #4084 to release/7.0: Fix API docs and doc include paths#4107
paulmedynski merged 2 commits intorelease/7.0from
copilot/port-pr-4084-to-release-7-0

Conversation

Copy link
Copy Markdown
Contributor

Copilot AI commented Mar 31, 2026

  • Cherry-pick PR Fix API docs #4084 changes (doc/snippets XML formatting fixes for SqlCommand.xml, SqlDataAdapter.xml, SqlDataReader.xml)
  • Fix doc include paths in SqlDataReader.cs (GetSqlJson, GetSqlVector) from ../../../../ to ../../../../../../
  • Fix doc include paths in SqlDbTypeExtensions.cs from ../../../../ to ../../../../../
  • Fix doc include paths in SqlJson.cs from ../../../../ to ../../../../../../
  • Fix doc include paths in SqlVector.cs from ../../../../ to ../../../../../../
  • Code review and security scan
  • Create PR against release/7.0

Copilot AI and others added 2 commits March 31, 2026 15:16
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>
@github-project-automation github-project-automation bot moved this to To triage in SqlClient Board Mar 31, 2026
Copilot AI requested a review from apoorvdeshmukh March 31, 2026 15:19
@apoorvdeshmukh apoorvdeshmukh added this to the 7.0.1 milestone Mar 31, 2026
@apoorvdeshmukh apoorvdeshmukh moved this from To triage to In review in SqlClient Board Mar 31, 2026
@apoorvdeshmukh apoorvdeshmukh added the Area\Documentation Use this for issues that requires changes in public documentations/samples. label Mar 31, 2026
@apoorvdeshmukh apoorvdeshmukh marked this pull request as ready for review March 31, 2026 15:36
@apoorvdeshmukh apoorvdeshmukh requested a review from a team as a code owner March 31, 2026 15:36
Copilot AI review requested due to automatic review settings March 31, 2026 15:36
Copy link
Copy Markdown
Contributor

Copilot AI left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

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 reference doc/snippets from the unified src/ 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.

@paulmedynski paulmedynski mentioned this pull request Mar 31, 2026
@codecov
Copy link
Copy Markdown

codecov bot commented Apr 1, 2026

Codecov Report

✅ All modified and coverable lines are covered by tests.
✅ Project coverage is 65.58%. Comparing base (864f666) to head (04ee13e).
⚠️ Report is 2 commits behind head on release/7.0.

❗ There is a different number of reports uploaded between BASE (864f666) and HEAD (04ee13e). Click for more details.

HEAD has 1 upload less than BASE
Flag BASE (864f666) HEAD (04ee13e)
CI-SqlClient 1 0
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     
Flag Coverage Δ
CI-SqlClient ?
PR-SqlClient-Project 65.58% <ø> (?)

Flags with carried forward coverage won't be shown. Click here to find out more.

☔ View full report in Codecov by Sentry.
📢 Have feedback on the report? Share it here.

🚀 New features to boost your workflow:
  • ❄️ Test Analytics: Detect flaky tests, report on failures, and find test suite problems.

@apoorvdeshmukh apoorvdeshmukh requested a review from a team April 1, 2026 05:52
@paulmedynski paulmedynski merged commit c3dd601 into release/7.0 Apr 6, 2026
303 of 305 checks passed
@paulmedynski paulmedynski deleted the copilot/port-pr-4084-to-release-7-0 branch April 6, 2026 11:05
@github-project-automation github-project-automation bot moved this from In review to Done in SqlClient Board Apr 6, 2026
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

Area\Documentation Use this for issues that requires changes in public documentations/samples.

Projects

Status: Done

Development

Successfully merging this pull request may close these issues.

5 participants