[7.0] Fix API docs#4119
Closed
paulmedynski wants to merge 1 commit intorelease/7.0from
Closed
Conversation
Contributor
There was a problem hiding this comment.
Pull request overview
Cherry-pick to release/7.0 that corrects API documentation snippet markup to resolve issues surfaced by the external sqlclient-api-docs build.
Changes:
- Fixes doc references for generic APIs (e.g.,
SqlVector<T>and retry-logic generic methods) to use the correct generic identifier formats. - Replaces incorrect method references (
OnRowUpdating/OnRowUpdated) with the corresponding event references (RowUpdating/RowUpdated) inSqlDataAdapterdocs. - Cleans up whitespace/trailing-space formatting across multiple snippet blocks to stabilize doc rendering.
Reviewed changes
Copilot reviewed 3 out of 3 changed files in this pull request and generated 1 comment.
| File | Description |
|---|---|
| doc/snippets/Microsoft.Data.SqlClient/SqlDataReader.xml | Updates GetSqlVector documentation to reference the generic SqlVector<T> type correctly; minor formatting cleanups. |
| doc/snippets/Microsoft.Data.SqlClient/SqlDataAdapter.xml | Fixes incorrect references to RowUpdated/RowUpdating as protected methods by pointing to the public events; whitespace cleanup. |
| doc/snippets/Microsoft.Data.SqlClient/SqlCommand.xml | Fixes xref formatting for generic retry-logic methods and updates vector-type references; whitespace cleanup. |
| ### How to use with legacy asynchronous commands | ||
| Besides assigning the provider to the command and executing the command, it's possible to run it directly using the following <xref:Microsoft.Data.SqlClient.SqlRetryLogicBaseProvider> methods: | ||
| - <xref:Microsoft.Data.SqlClient.SqlRetryLogicBaseProvider.Execute%60%601(System.Object,System.Func{%60%600})> | ||
| - <xref:Microsoft.Data.SqlClient.SqlRetryLogicBaseProvider.Execute``1(System.Object,System.Func{``0})> |
There was a problem hiding this comment.
The markdown heading just above these xref links contains a typo: "asynchoronous" should be "asynchronous".
Contributor
Author
|
Already tracked by #4107 . |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Cherry-pick of #4084 to release/7.0
Original PR Description
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