codes: update docstring to indicate expected usage

dfawley · Oct 6, 2023 · 7b03f8d · 7b03f8d
1 parent afaf31a
commit 7b03f8d
Showing 1 changed file with 7 additions and 1 deletion.
diff --git a/codes/codes.go b/codes/codes.go
@@ -25,7 +25,13 @@ import (
 	"strconv"
 )
 
-// A Code is an unsigned 32-bit error code as defined in the gRPC spec.
+// A Code is a status code according to the gRPC spec:
+//
+// https://github.com/grpc/grpc/blob/master/doc/statuscodes.md
+//
+// Only the codes defined as consts in this package are valid codes. Do not use
+// other code values.  Behavior and interopability are implementation-specific
+// and not guaranteed.
 type Code uint32
 
 const (