From baeae3a09291aab4c7a337322cc167c30b9af200 Mon Sep 17 00:00:00 2001 From: Dat Tien Nguyen Date: Tue, 15 Oct 2024 22:39:16 +0700 Subject: [PATCH] fix(nightly-rust): fix clippy for too long opening paragraph. Signed-off-by: Dat Tien Nguyen --- src/confchange/changer.rs | 4 +++- src/log_unstable.rs | 3 +++ src/read_only.rs | 1 + 3 files changed, 7 insertions(+), 1 deletion(-) diff --git a/src/confchange/changer.rs b/src/confchange/changer.rs index 32e23170..3c3e1112 100644 --- a/src/confchange/changer.rs +++ b/src/confchange/changer.rs @@ -33,7 +33,9 @@ impl IncrChangeMap<'_> { } } -/// Changer facilitates configuration changes. It exposes methods to handle +/// Changer facilitates configuration changes. +/// +/// It exposes methods to handle /// simple and joint consensus while performing the proper validation that allows /// refusing invalid configuration changes before they affect the active /// configuration. diff --git a/src/log_unstable.rs b/src/log_unstable.rs index e27b9cf6..dd90615e 100644 --- a/src/log_unstable.rs +++ b/src/log_unstable.rs @@ -20,6 +20,9 @@ use crate::eraftpb::{Entry, Snapshot}; use crate::util::entry_approximate_size; use slog::Logger; +/// Unstable contains "unstable" log entries and snapshot state that has +/// not yet been written to Storage. +/// /// The `unstable.entries[i]` has raft log position `i+unstable.offset`. /// Note that `unstable.offset` may be less than the highest log /// position in storage; this means that the next write to storage diff --git a/src/read_only.rs b/src/read_only.rs index 6ae37282..1dd0ffa4 100644 --- a/src/read_only.rs +++ b/src/read_only.rs @@ -37,6 +37,7 @@ pub enum ReadOnlyOption { } /// ReadState provides state for read only query. +/// /// It's caller's responsibility to send MsgReadIndex first before getting /// this state from ready. It's also caller's duty to differentiate if this /// state is what it requests through request_ctx, e.g. given a unique id as