Repository navigation
docs: Clarify the monotonic time-in-state documentation - #463
Closed
tanderson-ld wants to merge 1 commit into
Closed
tanderson-ld wants to merge 1 commit into
tanderson-ld wants to merge 1 commit into
Conversation
Explains why the condition predicates receive the elapsed time from the caller (the monotonic baseline is private to the status provider), and tightens the status_and_seconds_in_state doc.
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
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.
Follow-up to #459, documentation only.
fallback_condition/recovery_conditionwhy the caller supplies the elapsed time (the monotonic baseline is private to the status provider).status_and_seconds_in_statedoc comment to three sentences: what it returns, why one lock acquisition, and which value to use for duration decisions.Matches the wording used in the equivalent python-server-sdk change.
Note
Overview
Documentation-only follow-up clarifying how monotonic time-in-state is documented for FDv2 failover/recovery.
The
StatusProviderV2#status_and_seconds_in_statecomment is tightened to three sentences: what the method returns, why a single lock keeps status and duration consistent, and that callers should use the returned monotonic seconds (notstate_sincemath) for duration decisions.fallback_conditionandrecovery_conditionin FDv2 now document whyseconds_in_stateis passed in by the caller—the monotonic baseline lives inside the status provider—and point readers tostatus_and_seconds_in_state. Wording aligns with the equivalent python-server-sdk change.Reviewed by Cursor Bugbot for commit 165d8b4. Bugbot is set up for automated code reviews on this repo. Configure here.