[6.0] Update Docs - fix lists and tables (#3391) #3398
Merged
Conversation
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
* Update Docs - fix lists and tables * Fixes * Fix typos
There was a problem hiding this comment.
Pull Request Overview
Ports documentation updates from #3391 to the 6.0 release branch, standardizing XML list and table markup across reference snippets.
- Wraps all
<item>contents in<description>tags for consistency in bullet and numbered lists - Adjusts nested
<term>/<description>elements in table lists and nested lists - Updates header and item elements in snippets under both
Microsoft.SqlServer.ServerandMicrosoft.Data.SqlClient
Reviewed Changes
Copilot reviewed 18 out of 18 changed files in this pull request and generated no comments.
Show a summary per file
| File | Description |
|---|---|
| doc/snippets/Microsoft.SqlServer.Server/SqlUserDefinedTypeAttribute.xml | Wrapped bullet <item> content in <description> tags |
| doc/snippets/Microsoft.SqlServer.Server/Format.xml | Wrapped bullet <item> content in <description> tags |
| doc/snippets/Microsoft.Data.SqlClient/SqlTransaction.xml | Wrapped bullet <item> content in <description> tags |
| doc/snippets/Microsoft.Data.SqlClient/SqlRowUpdatingEventArgs.xml | Wrapped numbered <item> content in <description> tags |
| doc/snippets/Microsoft.Data.SqlClient/SqlRowUpdatedEventArgs.xml | Wrapped numbered <item> content in <description> tags |
| doc/snippets/Microsoft.Data.SqlClient/SqlParameter.xml | Wrapped bullet <item> content in <description> tags |
| doc/snippets/Microsoft.Data.SqlClient/SqlDependency.xml | Wrapped bullet <item> content in <description> tags |
| doc/snippets/Microsoft.Data.SqlClient/SqlDataReader.xml | Wrapped bullet <item> content in <description> tags |
| doc/snippets/Microsoft.Data.SqlClient/SqlDataAdapter.xml | Wrapped numbered <item> content in <description> tags |
| doc/snippets/Microsoft.Data.SqlClient/SqlCredential.xml | Wrapped bullet <item> content in <description> tags |
| doc/snippets/Microsoft.Data.SqlClient/SqlConnectionStringBuilder.xml | Wrapped bullet <item> content; adjusted table markup |
| doc/snippets/Microsoft.Data.SqlClient/SqlConnection.xml | Wrapped bullet <item> content in <description> tags |
| doc/snippets/Microsoft.Data.SqlClient/SqlConfigurableRetryFactory.xml | Wrapped bullet <item> content in <description> tags |
| doc/snippets/Microsoft.Data.SqlClient/SqlCommandColumnEncryptionSetting.xml | Wrapped bullet <item> content in <description> tags |
| doc/snippets/Microsoft.Data.SqlClient/SqlCommandBuilder.xml | Wrapped bullet <item> content in <description> tags |
| doc/snippets/Microsoft.Data.SqlClient/SqlBulkCopy.xml | Wrapped bullet <item> content in <description> tags |
| doc/snippets/Microsoft.Data.SqlClient/ActiveDirectoryAuthenticationProvider.xml | Wrapped bullet <item> content in <description> tags |
Comments suppressed due to low confidence (1)
doc/snippets/Microsoft.Data.SqlClient/SqlConnectionStringBuilder.xml:2009
- In a
list type="table"header, use<term>tags for each column heading rather than<description>. Replace<description>Type</description>,<description>Information provided</description>, and<description>Return value</description>with<term>Type</term>,<term>Information provided</term>, and<term>Return value</term>respectively.
<description>Type</description>
priyankatiwari08
approved these changes
Jun 9, 2025
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.
Ports #3391 to release/6.0
Docs can be found here: https://github.com/dotnet/sqlclient-api-docs/pull/83