Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Tweak C# docs for CreateTimer APIs #1903

Merged
merged 4 commits into from
Aug 2, 2021
Merged
Show file tree
Hide file tree
Changes from 3 commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
1 change: 1 addition & 0 deletions release_notes.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,5 +4,6 @@

* Fix message loss bug in ContinueAsNew scenarios ([Azure/durabletask#544](https://github.com/Azure/durabletask/pull/544))
* Allow custom connection string names when creating a DurableClient in an ASP.NET Core app (external app) (#1895)
* Improve API documentation regarding uncancelled timers (#1903)

## Breaking Changes
Original file line number Diff line number Diff line change
Expand Up @@ -328,7 +328,8 @@ public interface IDurableOrchestrationContext
/// <remarks>
/// All durable timers created using this method must either expire or be cancelled
/// using the <paramref name="cancelToken"/> before the orchestrator function completes.
/// Otherwise the underlying framework will keep the instance alive until the timer expires.
/// Otherwise the underlying framework will keep the instance in the "Running" state
/// even after the orchestrator function has completed.
/// </remarks>
/// <typeparam name="T">The type of <paramref name="state"/>.</typeparam>
/// <param name="fireAt">The time at which the timer should expire.</param>
Expand All @@ -343,7 +344,8 @@ public interface IDurableOrchestrationContext
/// <remarks>
/// All durable timers created using this method must either expire or be cancelled
/// using the <paramref name="cancelToken"/> before the orchestrator function completes.
/// Otherwise the underlying framework will keep the instance alive until the timer expires.
/// Otherwise the underlying framework will keep the instance in the "Running" state
/// even after the orchestrator function has completed.
/// </remarks>
/// <param name="fireAt">The time at which the timer should expire.</param>
/// <param name="cancelToken">The <c>CancellationToken</c> to use for cancelling the timer.</param>
Expand Down

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.