Fix API docs by apoorvdeshmukh · Pull Request #4084 · dotnet/SqlClient

apoorvdeshmukh · 2026-03-25T16:53:42Z

Description

This PR attempts to fix the issues seen in API docs in this PR

Issues

https://github.com/dotnet/sqlclient-api-docs/pull/94

Testing

Changes validated in this PR

Guidelines

Please review the contribution guidelines before submitting a pull request:

Copilot

Pull request overview

This PR updates the documentation snippet sources under doc/snippets/ to resolve API doc generation/linking issues (as observed in dotnet/sqlclient-api-docs#94), primarily by fixing xref/cref targets for generic APIs and cleaning up whitespace that can affect rendered docs.

Changes:

Fix SqlVector type references in SqlDataReader/SqlCommand docs to point to the generic SqlVector<T> (SqlVector\1`).
Update SqlDataAdapter docs to reference RowUpdating/RowUpdated events (event IDs) instead of the protected OnRowUpdating/OnRowUpdated methods.
Normalize whitespace/trailing spaces in embedded code examples and lists to avoid formatting noise in generated docs.

Reviewed changes

Copilot reviewed 3 out of 3 changed files in this pull request and generated no comments.

File	Description
doc/snippets/Microsoft.Data.SqlClient/SqlDataReader.xml	Fix `GetSqlVector` doc links to generic `SqlVector<T>` and clean whitespace in examples/lists.
doc/snippets/Microsoft.Data.SqlClient/SqlDataAdapter.xml	Correct xrefs to `RowUpdating`/`RowUpdated` events and remove trailing whitespace in examples.
doc/snippets/Microsoft.Data.SqlClient/SqlCommand.xml	Fix DocFX xref syntax for generic retry APIs and update `SqlVector<T>` xref; whitespace cleanup in examples.

codecov · 2026-03-26T06:30:40Z

Codecov Report

✅ All modified and coverable lines are covered by tests.
✅ Project coverage is 66.04%. Comparing base (60d4b92) to head (4795e69).
⚠️ Report is 8 commits behind head on main.

❗ There is a different number of reports uploaded between BASE (60d4b92) and HEAD (4795e69). Click for more details.

HEAD has 1 upload less than BASE

Flag BASE (60d4b92) HEAD (4795e69)

CI-SqlClient 1 0

Additional details and impacted files

@@            Coverage Diff             @@
##             main    #4084      +/-   ##
==========================================
- Coverage   73.22%   66.04%   -7.18%     
==========================================
  Files         280      275       -5     
  Lines       43000    65822   +22822     
==========================================
+ Hits        31486    43471   +11985     
- Misses      11514    22351   +10837

Flag	Coverage Δ
CI-SqlClient	`?`
PR-SqlClient-Project	`66.04% <ø> (?)`

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.

paulmedynski · 2026-03-26T14:30:02Z

@copilot When this PR merges, please port the changes to the release/7.0 branch and open a new PR with milestone 7.0.1.

Copilot · 2026-03-26T14:30:12Z

@paulmedynski I've opened a new pull request, #4093, to work on those changes. Once the pull request is ready, I'll request review from you.

Agent-Logs-Url: https://github.com/dotnet/SqlClient/sessions/1d30e5d6-ae83-4523-9c05-2e7b15d13480 Co-authored-by: apoorvdeshmukh <5858671+apoorvdeshmukh@users.noreply.github.com>

Updated [DotNetEnv](https://github.com/tonerdo/dotnet-env) from 3.1.1 to 3.2.0. <details> <summary>Release notes</summary> _Sourced from [DotNetEnv's releases](https://github.com/tonerdo/dotnet-env/releases)._ ## 3.2.0 - Switch parsing to Superpower (from Sprache) - Fix utf8 parsing - Interpolated variables parsing Commits viewable in [compare view](tonerdo/dotnet-env@v3.1.1...v3.2.0). </details> Updated [Microsoft.AspNetCore.Authentication.Google](https://github.com/dotnet/dotnet) from 10.0.6 to 10.0.7. <details> <summary>Release notes</summary> _Sourced from [Microsoft.AspNetCore.Authentication.Google's releases](https://github.com/dotnet/dotnet/releases)._ No release notes found for this version range. Commits viewable in [compare view](https://github.com/dotnet/dotnet/commits). </details> Updated [Microsoft.Data.SqlClient](https://github.com/dotnet/sqlclient) from 7.0.0 to 7.0.1. <details> <summary>Release notes</summary> _Sourced from [Microsoft.Data.SqlClient's releases](https://github.com/dotnet/sqlclient/releases)._ ## 7.0.1 This update brings the following changes since the [7.0.0](https://github.com/dotnet/SqlClient/blob/release/7.0/release-notes/7.0/7.0.0.md) release: ### Fixed - Fixed `SqlBulkCopy` failing on SQL Server 2016 with `Invalid column name 'graph_type'` error. The column metadata query now uses dynamic SQL so that references to the `graph_type` column (introduced in SQL Server 2017) are not compiled on older versions that lack the column. ([#3714](dotnet/SqlClient#3714), [#4092](dotnet/SqlClient#4092), [#4147](dotnet/SqlClient#4147)) - Fixed `SqlBulkCopy` failing on Azure Synapse Analytics dedicated SQL pools. The column-list query previously used a variable-assignment pattern that Synapse does not support; it now uses `STRING_AGG` when targeting Synapse (engine edition 6) and falls back to the variable-assignment approach for SQL Server 2016 compatibility. ([#4149](dotnet/SqlClient#4149), [#4176](dotnet/SqlClient#4176), [#4182](dotnet/SqlClient#4182)) - Fixed `SqlDataReader.GetFieldType()` and `GetProviderSpecificFieldType()` returning `typeof(byte[])` instead of `typeof(SqlVector<float>)` for vector float32 columns. The methods now follow the same type-determination logic as `GetValue()`. ([#4104](dotnet/SqlClient#4104), [#4105](dotnet/SqlClient#4105), [#4152](dotnet/SqlClient#4152)) - Added missing `System.Data.Common` (v4.3.0) NuGet package dependency for .NET Framework consumers. The inbox `System.Data.Common` assembly on .NET Framework predates APIs such as `IDbColumnSchemaGenerator`; without the explicit NuGet dependency, consumers encountered `CS0012` compilation errors when using these types through `Microsoft.Data.SqlClient`. ([#4063](dotnet/SqlClient#4063), [#4074](dotnet/SqlClient#4074)) ### Changed - Enabled the User Agent TDS feature extension unconditionally. The `Switch.Microsoft.Data.SqlClient.EnableUserAgent` AppContext switch has been removed; the driver now always sends User Agent information during login. ([#4124](dotnet/SqlClient#4124), [#4154](dotnet/SqlClient#4154)) - Added type forwards from the core `Microsoft.Data.SqlClient` assembly to public types that were moved to the `Microsoft.Data.SqlClient.Extensions.Abstractions` package: `SqlAuthenticationMethod`, `SqlAuthenticationParameters`, `SqlAuthenticationProvider`, `SqlAuthenticationProviderException`, and `SqlAuthenticationToken`. This ensures binary compatibility for assemblies compiled against earlier versions of `Microsoft.Data.SqlClient` where these types lived in the core assembly. ([#4067](dotnet/SqlClient#4067), [#4117](dotnet/SqlClient#4117)) - Fixed API documentation include paths and duplicate doc snippets. ([#4084](dotnet/SqlClient#4084), [#4086](dotnet/SqlClient#4086), [#4107](dotnet/SqlClient#4107), [#4161](dotnet/SqlClient#4161)) ## Contributors We thank the following public contributors. Their efforts toward this project are very much appreciated. - [edwardneal](https://github.com/edwardneal) ## Target Platform Support - .NET Framework 4.6.2+ (Windows x86, Windows x64, Windows ARM64) - .NET 8.0+ (Windows x86, Windows x64, Windows ARM, Windows ARM64, Linux, macOS) ### Dependencies #### .NET 9.0 - Microsoft.Bcl.Cryptography 9.0.13 - Microsoft.Data.SqlClient.Extensions.Abstractions 1.0.0 - Microsoft.Data.SqlClient.Internal.Logging 1.0.0 - Microsoft.Data.SqlClient.SNI.runtime 6.0.2 - Microsoft.Extensions.Caching.Memory 9.0.13 - Microsoft.IdentityModel.JsonWebTokens 8.16.0 - Microsoft.IdentityModel.Protocols.OpenIdConnect 8.16.0 - Microsoft.SqlServer.Server 1.0.0 - System.Configuration.ConfigurationManager 9.0.13 - System.Security.Cryptography.Pkcs 9.0.13 #### .NET 8.0 - Microsoft.Bcl.Cryptography 8.0.0 - Microsoft.Data.SqlClient.Extensions.Abstractions 1.0.0 ... (truncated) Commits viewable in [compare view](dotnet/SqlClient@v7.0.0...v7.0.1). </details> Dependabot will resolve any conflicts with this PR as long as you don't alter it yourself. You can also trigger a rebase manually by commenting `@dependabot rebase`. [//]: # (dependabot-automerge-start) [//]: # (dependabot-automerge-end) --- <details> <summary>Dependabot commands and options</summary> <br /> You can trigger Dependabot actions by commenting on this PR: - `@dependabot rebase` will rebase this PR - `@dependabot recreate` will recreate this PR, overwriting any edits that have been made to it - `@dependabot show <dependency name> ignore conditions` will show all of the ignore conditions of the specified dependency - `@dependabot ignore <dependency name> major version` will close this group update PR and stop Dependabot creating any more for the specific dependency's major version (unless you unignore this specific dependency's major version or upgrade to it yourself) - `@dependabot ignore <dependency name> minor version` will close this group update PR and stop Dependabot creating any more for the specific dependency's minor version (unless you unignore this specific dependency's minor version or upgrade to it yourself) - `@dependabot ignore <dependency name>` will close this group update PR and stop Dependabot creating any more for the specific dependency (unless you unignore this specific dependency or upgrade to it yourself) - `@dependabot unignore <dependency name>` will remove all of the ignore conditions of the specified dependency - `@dependabot unignore <dependency name> <ignore condition>` will remove the ignore condition of the specified dependency and ignore conditions </details> Signed-off-by: dependabot[bot] <support@github.com> Co-authored-by: dependabot[bot] <49699333+dependabot[bot]@users.noreply.github.com>

Fix API docs

4795e69

apoorvdeshmukh requested a review from a team as a code owner March 25, 2026 16:53

Copilot AI review requested due to automatic review settings March 25, 2026 16:53

github-project-automation Bot added this to SqlClient Board Mar 25, 2026

github-project-automation Bot moved this to To triage in SqlClient Board Mar 25, 2026

Copilot started reviewing on behalf of apoorvdeshmukh March 25, 2026 16:54 View session

Copilot AI reviewed Mar 25, 2026

View reviewed changes

apoorvdeshmukh modified the milestones: 7.0.1, 7.1.0 Mar 25, 2026

cheenamalhotra added the Hotfix Candidate 🚑 Issues/PRs that are candidate for backporting to earlier supported versions. label Mar 25, 2026

cheenamalhotra modified the milestones: 7.0.1, 7.1.0-preview1 Mar 25, 2026

paulmedynski self-assigned this Mar 26, 2026

paulmedynski approved these changes Mar 26, 2026

View reviewed changes

Copilot AI mentioned this pull request Mar 26, 2026

Fix API docs: SqlVector generic type refs, SqlDataAdapter event xrefs, and retry xref encoding #4093

Draft

cheenamalhotra approved these changes Mar 27, 2026

View reviewed changes

cheenamalhotra merged commit 8c88784 into main Mar 27, 2026
313 of 314 checks passed

cheenamalhotra deleted the dev/ad/fix-docs branch March 27, 2026 20:27

github-project-automation Bot moved this from To triage to Done in SqlClient Board Mar 27, 2026

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Fix API docs#4084

Fix API docs#4084
cheenamalhotra merged 1 commit intomainfrom
dev/ad/fix-docs

apoorvdeshmukh commented Mar 25, 2026

Uh oh!

Copilot AI left a comment

Uh oh!

codecov Bot commented Mar 26, 2026 •

edited

Loading

Uh oh!

paulmedynski commented Mar 26, 2026

Uh oh!

Copilot AI commented Mar 26, 2026

Uh oh!

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

5 participants

Conversation

apoorvdeshmukh commented Mar 25, 2026

Description

Issues

Testing

Guidelines

Uh oh!

Copilot AI left a comment

Choose a reason for hiding this comment

Pull request overview

Reviewed changes

Uh oh!

codecov Bot commented Mar 26, 2026 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Codecov Report

Uh oh!

paulmedynski commented Mar 26, 2026

Uh oh!

Copilot AI commented Mar 26, 2026

Uh oh!

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

5 participants

codecov Bot commented Mar 26, 2026 •

edited

Loading