docs: Document 0-disables-auto-recovery behavior for recovery_window_seconds - #1248
Open
Larslllllll wants to merge 1 commit into
Open
docs: Document 0-disables-auto-recovery behavior for recovery_window_seconds#1248Larslllllll wants to merge 1 commit into
Larslllllll wants to merge 1 commit into
Conversation
Fixes Maki-Zeninn#1000 - The recovery_window_seconds field's 0=disabled behavior wasn't documented, unlike similar fields like failure_threshold. This matches the doc style of sibling fields in RouteConfig.
This file contains hidden or 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
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
1 participant
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
Fixes #1000 - The
recovery_window_secondsfield's0=disabledbehavior wasn't documented, unlike similar fields likefailure_threshold.Changes
Updated the doc comment for
recovery_window_secondsto match the style of sibling fields:0means the circuit never auto-recoversreset_circuit_breakeris required when disabledVerification
This is a documentation-only change. The code behavior remains unchanged.