Skip to content

Commit 194fada

Browse files
cheenamalhotracheenamalhotra
authored
Update Docs - fix lists and tables (#3391)
* Update Docs - fix lists and tables * Fixes * Fix typos
1 parent 55095ef commit 194fada

18 files changed

+689
-687
lines changed

‎doc/snippets/Microsoft.Data.SqlClient/ActiveDirectoryAuthenticationProvider.xml

Lines changed: 8 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -180,14 +180,14 @@
180180
<remarks>
181181
The supported authentication modes with <see cref="T:Microsoft.Data.SqlClient.ActiveDirectoryAuthenticationProvider" /> are:
182182
<list type="bullet">
183-
<item>Active Directory Password</item>
184-
<item>Active Directory Integrated</item>
185-
<item>Active Directory Interactive</item>
186-
<item>Active Directory Service Principal</item>
187-
<item>Active Directory Device Code Flow</item>
188-
<item>Active Directory Managed Identity</item>
189-
<item>Active Directory MSI</item>
190-
<item>Active Directory Default</item>
183+
<item><description>Active Directory Password</description></item>
184+
<item><description>Active Directory Integrated</description></item>
185+
<item><description>Active Directory Interactive</description></item>
186+
<item><description>Active Directory Service Principal</description></item>
187+
<item><description>Active Directory Device Code Flow</description></item>
188+
<item><description>Active Directory Managed Identity</description></item>
189+
<item><description>Active Directory MSI</description></item>
190+
<item><description>Active Directory Default</description></item>
191191
</list>
192192
</remarks>
193193
</IsSupported>

‎doc/snippets/Microsoft.Data.SqlClient/SqlBulkCopy.xml

Lines changed: 68 additions & 68 deletions
Large diffs are not rendered by default.

‎doc/snippets/Microsoft.Data.SqlClient/SqlCommand.xml

Lines changed: 284 additions & 284 deletions
Large diffs are not rendered by default.

‎doc/snippets/Microsoft.Data.SqlClient/SqlCommandBuilder.xml

Lines changed: 18 additions & 18 deletions
Original file line numberDiff line numberDiff line change
@@ -229,15 +229,15 @@
229229
The default behavior, when generating parameter names, is to use <c>@p1</c>, <c>@p2</c>, and so on for the various parameters. Passing <see langword="true" /> for the <paramref name="useColumnsForParameterNames" /> parameter lets you force the command builder to generate parameters based on the column names instead. This succeeds only if the following conditions are met:
230230
</para>
231231
<list type="bullet">
232-
<item>
232+
<item><description>
233233
The <see cref="F:System.Data.Common.DbMetaDataColumnNames.ParameterNameMaxLength" /> returned from the <b>GetSchema</b> method call and found in the <see cref="F:System.Data.Common.DbMetaDataCollectionNames.DataSourceInformation" /> collection has been specified and its length is equal to or greater than the generated parameter name.
234-
</item>
235-
<item>
234+
</description></item>
235+
<item><description>
236236
The generated parameter name meets the criteria specified in the <see cref="F:System.Data.Common.DbMetaDataColumnNames.ParameterNamePattern" /> returned from the <b>GetSchema</b> method call and found in the <see cref="F:System.Data.Common.DbMetaDataCollectionNames.DataSourceInformation" /> collection regular expression.
237-
</item>
238-
<item>
237+
</description></item>
238+
<item><description>
239239
A <see cref="F:System.Data.Common.DbMetaDataColumnNames.ParameterMarkerFormat" /> returned from the <b>GetSchema</b> method call and found in the <see cref="F:System.Data.Common.DbMetaDataCollectionNames.DataSourceInformation" /> collection is specified.
240-
</item>
240+
</description></item>
241241
</list>
242242
<para>
243243
For more information, see <see href="https://learn.microsoft.com/sql/connect/ado-net/generate-commands-with-commandbuilders">Generating Commands with CommandBuilders</see>.
@@ -290,15 +290,15 @@
290290
The default behavior, when generating parameter names, is to use <c>@p1</c>, <c>@p2</c>, and so on for the various parameters. Passing <see langword="true" /> for the <paramref name="useColumnsForParameterNames" /> parameter lets you force the command builder to generate parameters based on the column names instead. This succeeds only if the following conditions are met:
291291
</para>
292292
<list type="bullet">
293-
<item>
293+
<item><description>
294294
The <see cref="F:System.Data.Common.DbMetaDataColumnNames.ParameterNameMaxLength" /> returned from the <b>GetSchema</b> method call and found in the <see cref="F:System.Data.Common.DbMetaDataCollectionNames.DataSourceInformation" /> collection has been specified and its length is equal to or greater than the generated parameter name.
295-
</item>
296-
<item>
295+
</description></item>
296+
<item><description>
297297
The generated parameter name meets the criteria specified in the <see cref="F:System.Data.Common.DbMetaDataColumnNames.ParameterNamePattern" /> returned from the <b>GetSchema</b> method call and found in the <see cref="F:System.Data.Common.DbMetaDataCollectionNames.DataSourceInformation" /> collection regular expression.
298-
</item>
299-
<item>
298+
</description></item>
299+
<item><description>
300300
A <see cref="F:System.Data.Common.DbMetaDataColumnNames.ParameterMarkerFormat" /> returned from the <b>GetSchema</b> method call and found in the <see cref="F:System.Data.Common.DbMetaDataCollectionNames.DataSourceInformation" /> collection is specified.
301-
</item>
301+
</description></item>
302302
</list>
303303
<para>
304304
For more information, see <see href="https://learn.microsoft.com/sql/connect/ado-net/generate-commands-with-commandbuilders">Generating Commands with CommandBuilders</see>.
@@ -407,15 +407,15 @@
407407
The default behavior, when generating parameter names, is to use <c>@p1</c>, <c>@p2</c>, and so on for the various parameters. Passing <see langword="true" /> for the <paramref name="useColumnsForParameterNames" /> parameter lets you force the command builder to generate parameters based on the column names instead. This succeeds only if the following conditions are met:
408408
</para>
409409
<list type="bullet">
410-
<item>
410+
<item><description>
411411
The <see cref="F:System.Data.Common.DbMetaDataColumnNames.ParameterNameMaxLength" /> returned from the <b>GetSchema</b> method call and found in the <see cref="F:System.Data.Common.DbMetaDataCollectionNames.DataSourceInformation" /> collection has been specified and its length is equal to or greater than the generated parameter name.
412-
</item>
413-
<item>
412+
</description></item>
413+
<item><description>
414414
The generated parameter name meets the criteria specified in the <see cref="F:System.Data.Common.DbMetaDataColumnNames.ParameterNamePattern" /> returned from the <b>GetSchema</b> method call and found in the <see cref="F:System.Data.Common.DbMetaDataCollectionNames.DataSourceInformation" /> collection regular expression.
415-
</item>
416-
<item>
415+
</description></item>
416+
<item><description>
417417
A <see cref="F:System.Data.Common.DbMetaDataColumnNames.ParameterMarkerFormat" /> returned from the <b>GetSchema</b> method call and found in the <see cref="F:System.Data.Common.DbMetaDataCollectionNames.DataSourceInformation" /> collection is specified.
418-
</item>
418+
</description></item>
419419
</list>
420420
<para>
421421
For more information, see <see href="https://learn.microsoft.com/sql/connect/ado-net/generate-commands-with-commandbuilders">Generating Commands with CommandBuilders</see>.

‎doc/snippets/Microsoft.Data.SqlClient/SqlCommandColumnEncryptionSetting.xml

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -6,12 +6,12 @@
66
</summary>
77
<remarks>
88
<list type="bullet">
9-
<item>
9+
<item><description>
1010
If Always Encrypted is disabled for a query and the query has parameters that need to be encrypted (parameters that correspond to encrypted columns), the query will fail.
11-
</item>
12-
<item>
11+
</description></item>
12+
<item><description>
1313
If Always Encrypted is disabled for a query and the query returns results from encrypted columns, the query will return encrypted values. The encrypted values will have the varbinary datatype.
14-
</item>
14+
</description></item>
1515
</list>
1616
</remarks>
1717
</SqlCommandColumnEncryptionSetting>

‎doc/snippets/Microsoft.Data.SqlClient/SqlConfigurableRetryFactory.xml

Lines changed: 30 additions & 30 deletions
Original file line numberDiff line numberDiff line change
@@ -138,21 +138,21 @@
138138
<exception cref="T:System.ArgumentOutOfRangeException">
139139
If at least one of the following conditions occurs:
140140
<list type="bullet">
141-
<item>
141+
<item><description>
142142
<see cref="P:Microsoft.Data.SqlClient.SqlRetryLogicOption.NumberOfTries" /> is less than 1 or bigger than 60.
143-
</item>
144-
<item>
143+
</description></item>
144+
<item><description>
145145
<see cref="P:Microsoft.Data.SqlClient.SqlRetryLogicOption.DeltaTime" /> is bigger than 120 seconds.
146-
</item>
147-
<item>
146+
</description></item>
147+
<item><description>
148148
<see cref="P:Microsoft.Data.SqlClient.SqlRetryLogicOption.MinTimeInterval" /> is bigger than 120 seconds.
149-
</item>
150-
<item>
149+
</description></item>
150+
<item><description>
151151
<see cref="P:Microsoft.Data.SqlClient.SqlRetryLogicOption.MaxTimeInterval" /> is bigger than 120 seconds.
152-
</item>
153-
<item>
152+
</description></item>
153+
<item><description>
154154
<see cref="P:Microsoft.Data.SqlClient.SqlRetryLogicOption.MinTimeInterval" /> is not less than <see cref="P:Microsoft.Data.SqlClient.SqlRetryLogicOption.MaxTimeInterval" />.
155-
</item>
155+
</description></item>
156156
</list>
157157
</exception>
158158
</CreateExponentialRetryProvider>
@@ -178,21 +178,21 @@
178178
<exception cref="T:System.ArgumentOutOfRangeException">
179179
If at least one of the following conditions occurs:
180180
<list type="bullet">
181-
<item>
181+
<item><description>
182182
<see cref="P:Microsoft.Data.SqlClient.SqlRetryLogicOption.NumberOfTries" /> is less than 1 or bigger than 60.
183-
</item>
184-
<item>
183+
</description></item>
184+
<item><description>
185185
<see cref="P:Microsoft.Data.SqlClient.SqlRetryLogicOption.DeltaTime" /> is bigger than 120 seconds.
186-
</item>
187-
<item>
186+
</description></item>
187+
<item><description>
188188
<see cref="P:Microsoft.Data.SqlClient.SqlRetryLogicOption.MinTimeInterval" /> is bigger than 120 seconds.
189-
</item>
190-
<item>
189+
</description></item>
190+
<item><description>
191191
<see cref="P:Microsoft.Data.SqlClient.SqlRetryLogicOption.MaxTimeInterval" /> is bigger than 120 seconds.
192-
</item>
193-
<item>
192+
</description></item>
193+
<item><description>
194194
<see cref="P:Microsoft.Data.SqlClient.SqlRetryLogicOption.MinTimeInterval" /> is not less than <see cref="P:Microsoft.Data.SqlClient.SqlRetryLogicOption.MaxTimeInterval" />.
195-
</item>
195+
</description></item>
196196
</list>
197197
</exception>
198198
</CreateIncrementalRetryProvider>
@@ -218,21 +218,21 @@
218218
<exception cref="T:System.ArgumentOutOfRangeException">
219219
If at least one of the following conditions occurs:
220220
<list type="bullet">
221-
<item>
221+
<item><description>
222222
<see cref="P:Microsoft.Data.SqlClient.SqlRetryLogicOption.NumberOfTries" /> is less than 1 or bigger than 60.
223-
</item>
224-
<item>
223+
</description></item>
224+
<item><description>
225225
<see cref="P:Microsoft.Data.SqlClient.SqlRetryLogicOption.DeltaTime" /> is bigger than 120 seconds.
226-
</item>
227-
<item>
226+
</description></item>
227+
<item><description>
228228
<see cref="P:Microsoft.Data.SqlClient.SqlRetryLogicOption.MinTimeInterval" /> is bigger than 120 seconds.
229-
</item>
230-
<item>
229+
</description></item>
230+
<item><description>
231231
<see cref="P:Microsoft.Data.SqlClient.SqlRetryLogicOption.MaxTimeInterval" /> is bigger than 120 seconds.
232-
</item>
233-
<item>
232+
</description></item>
233+
<item><description>
234234
<see cref="P:Microsoft.Data.SqlClient.SqlRetryLogicOption.MinTimeInterval" /> is not less than <see cref="P:Microsoft.Data.SqlClient.SqlRetryLogicOption.MaxTimeInterval" />.
235-
</item>
235+
</description></item>
236236
</list>
237237
</exception>
238238
</CreateFixedRetryProvider>

0 commit comments

Comments
 (0)