Minor documentation additions - Akka Streams RestartFlow and RestartSettings #6820
Conversation
This file contains 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
mhbuck
commented
Jun 28, 2023
| @@ -162,7 +162,7 @@ public static class RestartFlow | |||
| /// <para>This uses the same exponential backoff algorithm as <see cref="BackoffOptions"/>.</para> | |||
| /// </summary> | |||
| /// <param name="flowFactory">A factory for producing the <see cref="Flow"/>] to wrap.</param> | |||
| /// <param name="settings"></param> | |||
| /// <param name="settings"><see cref="RestartSettings" /> defining restart configuration</param> | |||
There was a problem hiding this comment.
Matching the documentation for the WithBackoff method in this class
Comment on lines
+29
to
+34
| /// <summary> | ||
| /// Creates a new instance of <see cref="RestartSettings"/> class | ||
| /// </summary> | ||
| /// <param name="minBackoff">Minimum (initial) duration until the child actor will started again, if it is terminated</param> | ||
| /// <param name="maxBackoff">The exponential back-off is capped to this duration</param> | ||
| /// <param name="randomFactor">After calculation of the exponential back-off an additional random delay based on this factor is added, e.g. `0.2` adds up to `20%` delay. In order to skip this additional delay pass in `0`.</param> |
There was a problem hiding this comment.
Addition of documentation matching the extension methods in the class
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.
Changes
Addition of method documentation that were found missing when working with restart logic.
Checklist
For significant changes, please ensure that the following have been completed (delete if not relevant):