Skip to content

docs: Clarify the monotonic time-in-state documentation - #463

Closed
tanderson-ld wants to merge 1 commit into
mainfrom
tanderson/sdk-3104-docs-clarify
Closed

tanderson-ld wants to merge 1 commit into
mainfrom
tanderson/sdk-3104-docs-clarify

Conversation

@tanderson-ld

@tanderson-ld tanderson-ld commented Oct 8, 2026 •

Copy link
Copy Markdown
Contributor

Follow-up to #459, documentation only.

  • Explains on fallback_condition / recovery_condition why the caller supplies the elapsed time (the monotonic baseline is private to the status provider).
  • Tightens the status_and_seconds_in_state doc 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_state comment 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 (not state_since math) for duration decisions.

fallback_condition and recovery_condition in FDv2 now document why seconds_in_state is passed in by the caller—the monotonic baseline lives inside the status provider—and point readers to status_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.

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.
@tanderson-ld
tanderson-ld requested a review from a team as a code owner October 8, 2026 18:02
@tanderson-ld
tanderson-ld requested a review from keelerm84 October 8, 2026 18:02
@tanderson-ld
tanderson-ld deleted the tanderson/sdk-3104-docs-clarify branch October 8, 2026 19:30
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant