agherr: imp docs

heyxkhoa · Mar 16, 2021 · c812999 · c812999
1 parent f43a5f5
commit c812999
Show file tree

Hide file tree

Showing 2 changed files with 4 additions and 1 deletion.
diff --git a/internal/agherr/agherr.go b/internal/agherr/agherr.go
@@ -22,6 +22,8 @@ type manyError struct {
 }
 
 // Many wraps several errors and returns a single error.
+//
+// TODO(a.garipov): Add formatting to message.
 func Many(message string, underlying ...error) (err error) {
 	err = &manyError{
 		message:    message,
@@ -92,6 +94,7 @@ type wrapper interface {
 //           // …
 //   }
 //
+// msg must contain the final ": %w" verb.
 func Annotate(msg string, errPtr *error, args ...interface{}) {
 	if errPtr == nil {
 		return

diff --git a/internal/agherr/agherr_test.go b/internal/agherr/agherr_test.go
@@ -83,7 +83,7 @@ func TestAnnotate(t *testing.T) {
 	const s = "1234"
 	const wantMsg = `bad string "1234": test`
 
-	// Don't use const, because we can't take a pointer of a contant.
+	// Don't use const, because we can't take a pointer of a constant.
 	var errTest error = Error("test")
 
 	t.Run("nil", func(t *testing.T) {