docs(retry): fix rendering docs #6850
Merged
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
3 tasks
| * @return A function that returns an Observable that will resubscribe to the | ||
| * source stream when the source stream errors, at most `count` times. | ||
| */ | ||
| export function retry<T>(count?: number): MonoTypeOperatorFunction<T>; |
| * | ||
| * @param config - The retry configuration | ||
| */ | ||
| export function retry<T>(config: RetryConfig): MonoTypeOperatorFunction<T>; |
|
|
||
| /** | ||
| * Returns an observable that mirrors the source observable unless it errors. If it errors, the source observable | ||
| * will be resubscribed to (or "retried") based on the configuration passed here. See documentation |
| @@ -63,22 +76,10 @@ export interface RetryConfig { | |||
| * | |||
| * @see {@link retryWhen} | |||
| * | |||
| * @param count - Number of retry attempts before failing. | |||
| * @param resetOnSuccess - When set to `true` every successful emission will reset the error count | |||
There was a problem hiding this comment.
This parameter doesn't exist anymore in this form, so I removed the docs for it. It is now part of the RetryConfig and it's properly documented.
benlesh
approved these changes
Mar 8, 2022
benlesh
added
7.x
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.
Description:
Please check the related issue for more info. This is how the page looks like with this fix (sorry for the large image):
Related issue (if exists):
#6660