add rustdoc for

hyperium · Sep 23, 2022 · e9d6aea · e9d6aea
1 parent 09f11fd
commit e9d6aea
Showing 1 changed file with 2 additions and 0 deletions.
diff --git a/tonic/src/lib.rs b/tonic/src/lib.rs
@@ -123,4 +123,6 @@ pub(crate) type Error = Box<dyn std::error::Error + Send + Sync>;
 #[cfg_attr(docsrs, doc(cfg(feature = "codegen")))]
 pub mod codegen;
 
+/// `Result` is a type that represents either success ([`Ok`]) or failure ([`Err`]).
+/// By default, the Err value is of type [`Status`] but this can be overridden if desired.
 pub type Result<T, E = Status> = std::result::Result<T, E>;