Fix API docs - #4084
#4084Conversation
There was a problem hiding this comment.
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
SqlVectortype references inSqlDataReader/SqlCommanddocs to point to the genericSqlVector<T>(SqlVector\1`). - Update
SqlDataAdapterdocs to referenceRowUpdating/RowUpdatedevents (event IDs) instead of the protectedOnRowUpdating/OnRowUpdatedmethods. - 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 Report✅ All modified and coverable lines are covered by tests.
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
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:
|
|
@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. |
|
@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>
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: