Skip to content

Commit 688b931

Browse files
Update cross reference errors in configurable retry logic documents (#1095)
1 parent d3f9130 commit 688b931

File tree

7 files changed

+22
-27
lines changed

7 files changed

+22
-27
lines changed

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

Lines changed: 8 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -2818,12 +2818,12 @@ The built-in column master key store providers that are available for the Window
28182818
You must set the value for this property before the command is executed for it to take effect.
28192819
28202820
To apply the retry logic, do the following steps before executing the command:
2821-
1. Define the configuration parameters by using <xref:Microsoft.Data.SqlClient.FixedRetryLogicOption> or <xref:Microsoft.Data.SqlClient.FloatingRetryLogicOption>.
2821+
1. Define the configuration parameters by using <xref:Microsoft.Data.SqlClient.SqlRetryLogicOption> type.
28222822
2. Create a <xref:Microsoft.Data.SqlClient.SqlRetryLogicBaseProvider> by using one of the following static methods of the <xref:Microsoft.Data.SqlClient.SqlConfigurableRetryFactory> class:
2823-
- <xref:Microsoft.Data.SqlClient.SqlRetryLogicBaseProvider.CreateFixedRetryProvider>
2824-
- <xref:Microsoft.Data.SqlClient.SqlRetryLogicBaseProvider.CreateIncrementalRetryProvider>
2825-
- <xref:Microsoft.Data.SqlClient.SqlRetryLogicBaseProvider.CreateExponentialRetryProvider>
2826-
- <xref:Microsoft.Data.SqlClient.SqlRetryLogicBaseProvider.CreateNoneRetryProvider>
2823+
- <xref:Microsoft.Data.SqlClient.SqlConfigurableRetryFactory.CreateFixedRetryProvider%2A>
2824+
- <xref:Microsoft.Data.SqlClient.SqlConfigurableRetryFactory.CreateIncrementalRetryProvider%2A>
2825+
- <xref:Microsoft.Data.SqlClient.SqlConfigurableRetryFactory.CreateExponentialRetryProvider%2A>
2826+
- <xref:Microsoft.Data.SqlClient.SqlConfigurableRetryFactory.CreateNoneRetryProvider%2A>
28272827
3. Assign the <xref:Microsoft.Data.SqlClient.SqlRetryLogicBaseProvider> object to the `RetryLogicProvider` property.
28282828
28292829
> [!NOTE]
@@ -2851,8 +2851,9 @@ The blocking connection simulates a situation like a command still running in th
28512851
28522852
### How to use with legacy asynchronous commands
28532853
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:
2854-
- <xref:Microsoft.Data.SqlClient.SqlRetryLogicBaseProvider.Execute>
2855-
- <xref:Microsoft.Data.SqlClient.SqlRetryLogicBaseProvider.ExecuteAsync>
2854+
- <xref:Microsoft.Data.SqlClient.SqlRetryLogicBaseProvider.Execute%60%601(System.Object,System.Func{%60%600})>
2855+
- <xref:Microsoft.Data.SqlClient.SqlRetryLogicBaseProvider.ExecuteAsync(System.Object,System.Func{System.Threading.Tasks.Task},System.Threading.CancellationToken)>
2856+
- <xref:Microsoft.Data.SqlClient.SqlRetryLogicBaseProvider.ExecuteAsync%60%601(System.Object,System.Func{System.Threading.Tasks.Task{%60%600}},System.Threading.CancellationToken)>
28562857
28572858
[!code-csharp[SqlConfigurableRetryLogic_SqlCommand#4](~/../sqlclient/doc/samples/SqlConfigurableRetryLogic_SqlCommand.cs#4)]
28582859

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

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -37,7 +37,7 @@ The following table shows the inner transient error list.
3737
</remarks>
3838
</SqlConfigurableRetryFactory>
3939
<CreateExponentialRetryProvider>
40-
<param name="retryLogicOption">An object of <see cref="T:Microsoft.Data.SqlClient.FloatingRetryLogicOption" /> containing the configuration for the object.</param>
40+
<param name="retryLogicOption">An object of <see cref="T:Microsoft.Data.SqlClient.SqlRetryLogicOption" /> containing the configuration for the object.</param>
4141
<summary>Provides an exponential time interval retry logic provider.</summary>
4242
<returns>A <see cref="T:Microsoft.Data.SqlClient.SqlRetryLogicBaseProvider" /> object.</returns>
4343
<remarks>
@@ -58,7 +58,7 @@ The following table shows the inner transient error list.
5858
</exception>
5959
</CreateExponentialRetryProvider>
6060
<CreateIncrementalRetryProvider>
61-
<param name="retryLogicOption">An object of <see cref="T:Microsoft.Data.SqlClient.FloatingRetryLogicOption" /> containing the configuration for the object.</param>
61+
<param name="retryLogicOption">An object of <see cref="T:Microsoft.Data.SqlClient.SqlRetryLogicOption" /> containing the configuration for the object.</param>
6262
<summary>Provides an incremental time interval retry logic provider.</summary>
6363
<returns>A <see cref="T:Microsoft.Data.SqlClient.SqlRetryLogicBaseProvider" /> object.</returns>
6464
<remarks>
@@ -79,7 +79,7 @@ The following table shows the inner transient error list.
7979
</exception>
8080
</CreateIncrementalRetryProvider>
8181
<CreateFixedRetryProvider>
82-
<param name="retryLogicOption">An object of <see cref="T:Microsoft.Data.SqlClient.FixedRetryLogicOption" /> containing the configuration for the object.</param>
82+
<param name="retryLogicOption">An object of <see cref="T:Microsoft.Data.SqlClient.SqlRetryLogicOption" /> containing the configuration for the object.</param>
8383
<summary>Provides a fixed interval time retry logic provider.</summary>
8484
<returns>A <see cref="T:Microsoft.Data.SqlClient.SqlRetryLogicBaseProvider" /> object.</returns>
8585
<remarks>

doc/snippets/Microsoft.Data.SqlClient/SqlConnection.xml

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -1104,12 +1104,12 @@ The built-in column master key store providers that are available for the Window
11041104
You must set the value for this property before opening the connection to take effect.
11051105
11061106
To apply the retry logic, do the following steps before opening the connection:
1107-
1. Define the configuration parameters by using <xref:Microsoft.Data.SqlClient.FixedRetryLogicOption> or <xref:Microsoft.Data.SqlClient.FloatingRetryLogicOption>.
1107+
1. Define the configuration parameters by using <xref:Microsoft.Data.SqlClient.SqlRetryLogicOption> type.
11081108
2. Create a <xref:Microsoft.Data.SqlClient.SqlRetryLogicBaseProvider> by using one of the following static methods of the <xref:Microsoft.Data.SqlClient.SqlConfigurableRetryFactory> class:
1109-
- <xref:Microsoft.Data.SqlClient.SqlConfigurableRetryFactory.CreateFixedRetryProvider>
1110-
- <xref:Microsoft.Data.SqlClient.SqlConfigurableRetryFactory.CreateIncrementalRetryProvider>
1111-
- <xref:Microsoft.Data.SqlClient.SqlConfigurableRetryFactory.CreateExponentialRetryProvider>
1112-
- <xref:Microsoft.Data.SqlClient.SqlConfigurableRetryFactory.CreateNoneRetryProvider>
1109+
- <xref:Microsoft.Data.SqlClient.SqlConfigurableRetryFactory.CreateFixedRetryProvider%2A>
1110+
- <xref:Microsoft.Data.SqlClient.SqlConfigurableRetryFactory.CreateIncrementalRetryProvider%2A>
1111+
- <xref:Microsoft.Data.SqlClient.SqlConfigurableRetryFactory.CreateExponentialRetryProvider%2A>
1112+
- <xref:Microsoft.Data.SqlClient.SqlConfigurableRetryFactory.CreateNoneRetryProvider%2A>
11131113
3. Assign the <xref:Microsoft.Data.SqlClient.SqlRetryLogicBaseProvider> object to the `RetryLogicProvider` property.
11141114
11151115
> [!NOTE]

doc/snippets/Microsoft.Data.SqlClient/SqlRetryIntervalBaseEnumerator.xml

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -12,7 +12,7 @@
1212
<param name="maxTime">The maximum time allowed as a gap time.</param>
1313
<param name="minTime">The minimum time allowed as a gap time.</param>
1414
<summary>Initializes a new instance of the <see cref="T:Microsoft.Data.SqlClient.SqlRetryIntervalBaseEnumerator" /> class.</summary>
15-
<exception cref="T:System.ArgumentOutOfRangeException">The supplied arguments failed <see cref="T:Microsoft.Data.SqlClient.SqlRetryIntervalBaseEnumerator.Validate" /> validation.</exception>
15+
<exception cref="T:System.ArgumentOutOfRangeException">The supplied arguments failed <see cref="M:Microsoft.Data.SqlClient.SqlRetryIntervalBaseEnumerator.Validate(System.TimeSpan,System.TimeSpan,System.TimeSpan)" /> validation.</exception>
1616
</ctor2>
1717
<GapTimeInterval>
1818
<summary>The default gap time of each interval.</summary>

doc/snippets/Microsoft.Data.SqlClient/SqlRetryLogicBase.xml

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -22,7 +22,7 @@
2222
<TransientPredicate>
2323
<summary>Delegate to a transient condition predicate. The function that this delegate points to must return a true value when an expected transient exception happens.</summary>
2424
<value>
25-
<see cref="T:System.Predicate" /> value that delegates to a function that receives a <see cref="T:System.Exception" /> input parameter.</value>
25+
<see cref="T:System.Predicate`1" /> value that delegates to a function that receives a <see cref="T:System.Exception" /> input parameter.</value>
2626
</TransientPredicate>
2727
<RetryCondition>
2828
<param name="sender">The sender object.</param>

doc/snippets/Microsoft.Data.SqlClient/SqlRetryLogicBaseProvider.xml

Lines changed: 3 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -34,9 +34,7 @@
3434
<typeparam name = "TResult">The object that the `function` returns when executed.</typeparam>
3535
<param name="sender">The source of the event.</param>
3636
<param name="function">The operation to re-execute if a transient condition occurs.</param>
37-
<summary>Executes a function and applies retry logic, if enabled.
38-
39-
Exceptions will be reported via an aggregate exception if the execution isn't successful via retry attempts.
37+
<summary>Executes a function and applies retry logic, if enabled. **Note:** Exceptions will be reported via an aggregate exception if the execution isn't successful via retry attempts.
4038
</summary>
4139
<returns>The return value of the `function` if it runs without exception.</returns>
4240
<remarks>
@@ -56,9 +54,7 @@
5654
<param name="sender">The source of the event.</param>
5755
<param name="function">The operation to re-execute if a transient condition occurs.</param>
5856
<param name="cancellationToken">The cancellation instruction.</param>
59-
<summary>Executes a function and applies retry logic, if enabled. The cancellation token can be used to request that the operation be abandoned before the execution attempts are exceeded.
60-
61-
Exceptions will be reported via the returned Task object, which will contain an aggregate exception if execution fails for all retry attempts.</summary>
57+
<summary>Executes a function and applies retry logic, if enabled. The cancellation token can be used to request that the operation be abandoned before the execution attempts are exceeded. **Note:** Exceptions will be reported via the returned Task object, which will contain an aggregate exception if execution fails for all retry attempts.</summary>
6258
<returns>A task representing the asynchronous operation. The results of the task will be the return value of the `function`, if it runs without exception.</returns>
6359
<remarks>
6460
<format type="text/markdown"><![CDATA[
@@ -76,9 +72,7 @@
7672
<param name="sender">The source of the event.</param>
7773
<param name="function">The operation to re-execute if a transient condition occurs.</param>
7874
<param name="cancellationToken">The cancellation instruction.</param>
79-
<summary>Executes a function and applies retry logic, if enabled. The cancellation token can be used to request that the operation be abandoned before the execution attempts are exceeded.
80-
81-
Exceptions will be reported via the returned Task object, which will contain an aggregate exception if execution fails for all retry attempts.</summary>
75+
<summary>Executes a function and applies retry logic, if enabled. The cancellation token can be used to request that the operation be abandoned before the execution attempts are exceeded. **Note:** Exceptions will be reported via the returned Task object, which will contain an aggregate exception if execution fails for all retry attempts.</summary>
8276
<returns>A Task or an exception.</returns>
8377
<remarks>
8478
<format type="text/markdown"><![CDATA[

doc/snippets/Microsoft.Data.SqlClient/SqlRetryLogicOption.xml

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -41,7 +41,7 @@ The following sample declares a <xref:Microsoft.Data.SqlClient.SqlRetryLogicOpti
4141
<AuthorizedSqlCondition>
4242
<summary>Sets a pre-retry validation function on the <see cref="T:Microsoft.Data.SqlClient.SqlCommand.CommandText" /> to only include specific SQL statements.</summary>
4343
<value>
44-
<see cref="T:System.Predicate" /> The pre-retry validation delegate function; <see langword="true" /> if the `CommandText` is authorized to retry the operation.</value>
44+
<see cref="T:System.Predicate`1" /> The pre-retry validation delegate function; <see langword="true" /> if the `CommandText` is authorized to retry the operation.</value>
4545
</AuthorizedSqlCondition>
4646
</members>
4747
</docs>

0 commit comments

Comments
 (0)