Skip to content

Commit f0df03f

Browse files
committed
fix documentation
1 parent 362aa5f commit f0df03f

File tree

2 files changed

+4
-3
lines changed

2 files changed

+4
-3
lines changed

src/client/config.rs

+3-2
Original file line numberDiff line numberDiff line change
@@ -96,7 +96,7 @@ pub struct Config {
9696
/// * [`Client::send_and_forget`](crate::client::Client::send_and_forget)
9797
/// * [`Client::send_batch`](crate::client::Client::send_batch)
9898
pub retry_on_error: bool,
99-
/// Reconnection configuration (Constant, Linear or Exponential)
99+
/// Reconnection policy configuration (Constant, Linear or Exponential)
100100
pub reconnection: ReconnectionConfig,
101101
}
102102

@@ -880,7 +880,8 @@ pub enum ReconnectionConfig {
880880
jitter: u32,
881881
},
882882
/// Backoff reconnection attempts exponentially, multiplying the last delay by `multiplicative_factor` each time.
883-
/// see https://en.wikipedia.org/wiki/Exponential_backoff
883+
///
884+
/// see <https://en.wikipedia.org/wiki/Exponential_backoff>
884885
Exponential {
885886
/// Maximum number of attemps, set `0` to retry forever.
886887
max_attempts: u32,

src/client/mod.rs

+1-1
Original file line numberDiff line numberDiff line change
@@ -213,8 +213,8 @@ of the struct [`Config`] or its dependencies:
213213
it easier to identity the connection in client list.
214214
* [`keep_alive`](Config::keep_alive) - Enable/disable keep-alive functionality (default `None`)
215215
* [`no_delay`](Config::no_delay) - Enable/disable the use of Nagle's algorithm (default `true`)
216-
* [`max_command_attempts`](Config::max_command_attempts) - Maximum number of retry attempts to send a command to the Redis server (default `3`).
217216
* [`retry_on_error`](Config::retry_on_error) - Defines the default strategy for retries on network error (default `false`).
217+
* [`reconnection`](Config::reconnection) - Reconnection policy configuration: Constant, Linear or Exponential (default `Constant`)
218218
* [`wait_between_failures`](SentinelConfig::wait_between_failures) - (Sentinel only) Waiting time after
219219
failing before connecting to the next Sentinel instance (default `250` ms).
220220
* [`sentinel_username`](SentinelConfig::username) - (Sentinel only) Sentinel username

0 commit comments

Comments
 (0)