docs(client): document reconnect config default values#827
Open
jenish-25 wants to merge 1 commit into
Open
Conversation
The auto-reconnect support added in 13.1.0 exposes `ReconnectConfig` and `Backoff`, but their default values were only discoverable by reading the crate source (rpcpool#812). Add rustdoc to both structs and their fields documenting the defaults: backoff 10ms initial interval, 2.0 multiplier, 3 retries; slot_retention 250 slots. Closes rpcpool#812
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.
The auto-reconnect support added in 13.1.0 exposes
ReconnectConfigandBackoff, but their default values were only discoverable by reading the crate source (see #812).This adds rustdoc to
ReconnectConfigandBackoffand their fields, documenting the defaults:backoff.initial_interval:10msbackoff.multiplier:2.0backoff.max_retries:3slot_retention:250slotsDocs-only; no behavior change. Verified with
cargo doc(no broken intra-doc links) andcargo fmt --check.Closes #812