Skip to content

Fix API docs#4084

Merged
cheenamalhotra merged 1 commit intomainfrom
dev/ad/fix-docs
Mar 27, 2026
Merged

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

Conversation

@apoorvdeshmukh
Copy link
Copy Markdown
Contributor

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:

@apoorvdeshmukh 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 github-project-automation Bot moved this to To triage in SqlClient Board Mar 25, 2026
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

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.

@apoorvdeshmukh apoorvdeshmukh modified the milestones: 7.0.1, 7.1.0 Mar 25, 2026
@cheenamalhotra cheenamalhotra added the Hotfix Candidate 🚑 Issues/PRs that are candidate for backporting to earlier supported versions. label Mar 25, 2026
@cheenamalhotra cheenamalhotra modified the milestones: 7.0.1, 7.1.0-preview1 Mar 25, 2026
@codecov
Copy link
Copy Markdown

codecov Bot commented Mar 26, 2026

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 paulmedynski self-assigned this Mar 26, 2026
@paulmedynski
Copy link
Copy Markdown
Contributor

@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.

Copy link
Copy Markdown
Contributor

Copilot AI commented Mar 26, 2026

@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.

@cheenamalhotra cheenamalhotra merged commit 8c88784 into main Mar 27, 2026
313 of 314 checks passed
@cheenamalhotra cheenamalhotra deleted the dev/ad/fix-docs branch March 27, 2026 20:27
@github-project-automation github-project-automation Bot moved this from To triage to Done in SqlClient Board Mar 27, 2026
Copilot AI added a commit that referenced this pull request Mar 31, 2026
Agent-Logs-Url: https://github.com/dotnet/SqlClient/sessions/1d30e5d6-ae83-4523-9c05-2e7b15d13480

Co-authored-by: apoorvdeshmukh <5858671+apoorvdeshmukh@users.noreply.github.com>
This was referenced Apr 27, 2026
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

Hotfix Candidate 🚑 Issues/PRs that are candidate for backporting to earlier supported versions.

Projects

Status: Done

Development

Successfully merging this pull request may close these issues.

5 participants