doc

Author: ettec

pkg/capabilities/errors/error_codes.go

@@ -2,11 +2,11 @@ package errors
 
 type ErrorCode uint32
 
-// Capability error codes. These are largely based on gRPC error codes:
-// https://grpc.github.io/grpc/core/md_doc_statuscodes.html.  Additional
-// custom error codes can be added starting from 100 to avoid collision with
-// future gRPC defined codes.  0 (OK) is excluded is it is never a valid code for
-// a capability error as capability errors must always represent some failure condition.
+// Capability error codes are primarily based on gRPC error codes:
+// https://grpc.github.io/grpc/core/md_doc_statuscodes.html
+// Custom error codes specific to this project should start from 100 to avoid
+// conflicts with future gRPC codes. Note: 0 (OK) is intentionally excluded
+// because capability errors must always indicate a failure condition.
 const (
 	// Canceled indicates the operation was canceled (typically by the caller).
 	Canceled ErrorCode = 1
@@ -122,7 +122,7 @@ const (
 	// authentication credentials for the operation.
 	Unauthenticated ErrorCode = 16
 
-	// Custom error codes not defined in the gRPC error space below here,
+	// Custom error codes not defined in the gRPC error space are defined below this point,
 	// starting at 100 to avoid collision with future gRPC defined codes.
 
 	// ConsensusFailed indicates failure to reach consensus