godoc

Author: PeterIvanov

common.go

@@ -1,7 +1,7 @@
 package errorx
 
 var (
-	// General purpose errors to be used universally.
+	// CommonErrors is a namespace for general purpose errors designed for universal use.
 	// These errors should typically be used in opaque manner, implying no handing in user code.
 	// When handling is required, it is best to use custom error types with both standard and custom traits.
 	CommonErrors = NewNamespace("common")

modifier.go

@@ -1,15 +1,15 @@
 package errorx
 
-// Modifier is a way to change a default behaviour for an error type, directly or via type hierarchy.
+// TypeModifier is a way to change a default behaviour for an error type, directly or via type hierarchy.
 // Modification is intentionally one-way, as it provides much more clarity.
 // If there is a modifier on a type or a namespace, all its descendants definitely have the same default behaviour.
 // If some of a subtypes must lack a specific modifier, then the modifier must be removed from the common ancestor.
 type TypeModifier int
 
 const (
-	// An error type with such modifier creates transparent wrappers by default
+	// TypeModifierTransparent is a type modifier; an error type with such modifier creates transparent wrappers by default
 	TypeModifierTransparent TypeModifier = 1
-	// An error type with such modifier omits the stack trace collection upon creation of an error instance
+	// TypeModifierOmitStackTrace is a type modifier; an error type with such modifier omits the stack trace collection upon creation of an error instance
 	TypeModifierOmitStackTrace TypeModifier = 2
 )
 

namespace.go

@@ -17,7 +17,7 @@ type Namespace struct {
 	modifiers modifiers
 }
 
-// Namespace itself is not comparable, so a key be used instead.
+// NamespaceKey is a comparable descriptor of a Namespace.
 type NamespaceKey struct {
 	id   int64
 	name string

property.go

@@ -18,12 +18,12 @@ func RegisterProperty(label string) Property {
 	return newProperty(label)
 }
 
-// Context property, value is expected to be of context.Context type.
+// PropertyContext is a context property, value is expected to be of context.Context type.
 func PropertyContext() Property {
 	return propertyContext
 }
 
-// Payload property, value may contain user defined structure with arbitrary data passed along with an error.
+// PropertyPayload is a payload property, value may contain user defined structure with arbitrary data passed along with an error.
 func PropertyPayload() Property {
 	return propertyPayload
 }

stacktrace.go

@@ -9,7 +9,7 @@ import (
 	"sync/atomic"
 )
 
-// A used defined transformer for file path in stack trace output
+// StackTraceFilePathTransformer is a  used defined transformer for file path in stack trace output.
 type StackTraceFilePathTransformer func(string) string
 
 // InitializeStackTraceTransformer provides a transformer to be used in formatting of all the errors.

switch.go

@@ -1,8 +1,12 @@
 package errorx
 
+// CaseNoTrait is a synthetic type used in TypeSwitch, signifying a presence of non-nil error of some other type.
 func NotRecognisedType() *Type { return notRecognisedType }
 
+// CaseNoError is a synthetic trait used in TraitSwitch, signifying an absence of error.
 func CaseNoError() Trait { return caseNoError }
+
+// CaseNoTrait is a synthetic trait used in TraitSwitch, signifying a presence of non-nil error that lacks specified traits.
 func CaseNoTrait() Trait { return caseNoTrait }
 
 var (
@@ -43,7 +47,7 @@ func TypeSwitch(err error, types ...*Type) *Type {
 // For error types that lack any of the provided traits, including non-errorx errors, CaseNoTrait() is returned.
 // It is safe to treat CaseNoTrait() as 'any other kind of not-nil error' case.
 // The effect is equivalent to a series of HasTrait() checks.
-
+//
 // NB: if more than one provided types matches the error, the first match in the providers list is recognised.
 func TraitSwitch(err error, traits ...Trait) Trait {
 	typed := Cast(err)

trait.go

@@ -26,16 +26,16 @@ func HasTrait(err error, key Trait) bool {
 	return typedErr.HasTrait(key)
 }
 
-// A trait that signifies that an error is temporary in nature.
+// Temporary is a trait that signifies that an error is temporary in nature.
 func Temporary() Trait { return traitTemporary }
 
-// A trait that signifies that an error is some sort iof timeout.
+// Timeout is a trait that signifies that an error is some sort iof timeout.
 func Timeout() Trait { return traitTimeout }
 
-// A trait that marks such an error where the requested object is not found.
+// NotFound is a trait that marks such an error where the requested object is not found.
 func NotFound() Trait { return traitNotFound }
 
-// A trait that marks such an error where an update is failed as a duplicate.
+// Duplicate is a trait that marks such an error where an update is failed as a duplicate.
 func Duplicate() Trait { return traitDuplicate }
 
 // IsTemporary checks for Temporary trait.