status: document nil error handling of FromError (#4196)

Signed-off-by: Gaurav Gahlot <gauravgahlot0107@gmail.com>
grpc · Feb 9, 2021 · 61962d0 · 61962d0
1 parent 9280052
commit 61962d0
Showing 1 changed file with 5 additions and 3 deletions.
diff --git a/status/status.go b/status/status.go
@@ -73,9 +73,11 @@ func FromProto(s *spb.Status) *Status {
 	return status.FromProto(s)
 }
 
-// FromError returns a Status representing err if it was produced from this
-// package or has a method `GRPCStatus() *Status`. Otherwise, ok is false and a
-// Status is returned with codes.Unknown and the original error message.
+// FromError returns a Status representing err if it was produced by this
+// package or has a method `GRPCStatus() *Status`.
+// If err is nil, a Status is returned with codes.OK and no message.
+// Otherwise, ok is false and a Status is returned with codes.Unknown and
+// the original error message.
 func FromError(err error) (s *Status, ok bool) {
 	if err == nil {
 		return nil, true