From 8975139d89216e0364f981c59e709b9728411fe2 Mon Sep 17 00:00:00 2001 From: bsbds <69835502+bsbds@users.noreply.github.com> Date: Tue, 11 Jul 2023 18:12:31 +0800 Subject: [PATCH] docs: update docs of maintenance client Signed-off-by: bsbds <69835502+bsbds@users.noreply.github.com> --- xline-client/src/clients/maintenance.rs | 6 +++--- 1 file changed, 3 insertions(+), 3 deletions(-) diff --git a/xline-client/src/clients/maintenance.rs b/xline-client/src/clients/maintenance.rs index 02da596d0..162818629 100644 --- a/xline-client/src/clients/maintenance.rs +++ b/xline-client/src/clients/maintenance.rs @@ -1,7 +1,7 @@ use std::{fmt::Debug, sync::Arc}; use tonic::{transport::Channel, Streaming}; -use xlineapi::{self, SnapshotRequest, SnapshotResponse}; +use xlineapi::{SnapshotRequest, SnapshotResponse}; use crate::{ error::{ClientError, Result}, @@ -16,7 +16,7 @@ pub struct MaintenanceClient { } impl MaintenanceClient { - /// Create a new maintenance client + /// Creates a new maintenance client #[inline] #[must_use] pub fn new(channel: Channel, token: Option) -> Self { @@ -32,7 +32,7 @@ impl MaintenanceClient { /// /// # Errors /// - /// If the RPC client fails to send request + /// This function will return an error if the inner RPC client encountered a propose failure #[inline] pub async fn snapshot(&mut self) -> Result> { Ok(self