doc: result

Signed-off-by: ekexium <ekexium@gmail.com>
2020-11-10 15:50:21 +08:00 · 2020-11-10 15:50:21 +08:00 · a92f3710fe
parent cfbf87d3bc
commit a92f3710fe
1 changed files with 2 additions and 1 deletions
--- a/tikv-client-common/src/errors.rs
+++ b/tikv-client-common/src/errors.rs
@ -187,7 +187,8 @@ impl From<tikv_client_proto::kvrpcpb::KeyError> for Error {
    }
 }

-/// A result holding an [`Error`](Error).
+/// The result type used in tikv-client. 
+/// It holds an error type that contains varisous kinds of error that can happen in the crate.
 pub type Result<T> = result::Result<T, Error>;

 #[macro_export]