FIXUP - PR requests

errors/error.go → errors/defraError.go

@@ -17,6 +17,8 @@ import (
 	"strings"
 )
 
+const StackKey string = "Stack"
+
 var (
 	_ error         = (*defraError)(nil)
 	_ fmt.Formatter = (*defraError)(nil)
@@ -63,6 +65,9 @@ func (e *defraError) Unwrap() error {
 	return e.inner
 }
 
+// Format writes the error into the given state.
+//
+// Currently the following runes are supported: `v[+]` (+ also writes out the stacktrace), `s`, `q`.
 func (e *defraError) Format(f fmt.State, verb rune) {
 	errorString := e.Error()
 	switch verb {
@@ -80,6 +85,6 @@ func (e *defraError) Format(f fmt.State, verb rune) {
 	case 's':
 		_, _ = io.WriteString(f, errorString)
 	case 'q':
-		fmt.Fprintf(f, "%q", errorString)
+		_, _ = fmt.Fprintf(f, "%q", errorString)
 	}
 }

errors/errors.go

@@ -17,10 +17,7 @@ import (
 	goErrors "github.com/go-errors/errors"
 )
 
-const InnerErrorKey string = "Inner"
-const StackKey string = "Stack"
-
-// todo: make these configurable:
+// todo: make this configurable:
 // https://github.com/sourcenetwork/defradb/issues/733
 const MaxStackDepth int = 50
 
@@ -39,7 +36,7 @@ func NewKV(key string, value interface{}) KV {
 // New creates a new Defra error, suffixing any key-value
 // pairs provided.
 //
-// A stacktrace will be yielded if formating with a `+`, e.g `fmt.Sprintf("%+v", err)`.
+// A stacktrace will be yielded if formatting with a `+`, e.g `fmt.Sprintf("%+v", err)`.
 func New(message string, keyvals ...KV) error {
 	return newError(message, keyvals...)
 }
@@ -56,11 +53,9 @@ func newError(message string, keyvals ...KV) *defraError {
 	return withStackTrace(message, keyvals...)
 }
 
-// ErrorS creates a new Defra error, suffixing any key-value
-// pairs provided, and a stacktrace.
 func withStackTrace(message string, keyvals ...KV) *defraError {
 	stackBuffer := make([]uintptr, MaxStackDepth)
-	// Skip the first X frames as they are part of the error generation library and are
+	// Skip the first X frames as they are part of this library (and dependencies) and are
 	// best hidden.
 	length := runtime.Callers(4, stackBuffer[:])
 	stack := stackBuffer[:length]