From e9d6aea2248cc196cefa769eaf640354c9d2952d Mon Sep 17 00:00:00 2001
From: Steve Sampson <mail@stephensampson.dev>
Date: Fri, 23 Sep 2022 19:55:51 -0300
Subject: [PATCH] add rustdoc for

---
 tonic/src/lib.rs | 2 ++
 1 file changed, 2 insertions(+)

diff --git a/tonic/src/lib.rs b/tonic/src/lib.rs
index 0f7e84e19..b610017ab 100644
--- 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>;
\ No newline at end of file