Skip to content

Commit 2468160

Browse files
author
Dean Karn
committed
Update Docs
1 parent bd82447 commit 2468160

File tree

2 files changed

+6
-4
lines changed

2 files changed

+6
-4
lines changed

README.md

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -6,14 +6,14 @@ Package errors
66
[![GoDoc](https://godoc.org/github.com/go-playground/errors?status.svg)](https://godoc.org/github.com/go-playground/errors)
77
![License](https://img.shields.io/dub/l/vibe-d.svg)
88

9-
Package errors is an errors wrapping package to help propogate not only produce a chain of errors, but also
10-
stack trace, any tags(additional information) and even a Type classification system to categorize errors into types eg. Permanent vs Transient.
9+
Package errors is an errors wrapping package to help propagate and chain errors as well as attach
10+
stack traces, tags(additional information) and even a Type classification system to categorize errors into types eg. Permanent vs Transient.
1111

1212

1313
Common Questions
1414

1515
Why another package?
16-
Because most of the existing packages either don't take the error handling far enough, too far or down right unfriendly to use/consume.
16+
Because IMO most of the existing packages either don't take the error handling far enough, too far or down right unfriendly to use/consume.
1717

1818
Features
1919
--------

wrapped.go

Lines changed: 3 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -28,7 +28,9 @@ func newWrapped(err error, prefix string) *Wrapped {
2828
// Wrapped contains a single error entry, unless it's the top level error, in
2929
// which case it only contains an array of errors
3030
type Wrapped struct {
31-
// hidden field with wrapped errors, will expose a helper method to get this
31+
// Errors contains the chain of errors and is only set on the top level error
32+
// so if len() > 0 it's the top level error and no other error information is
33+
// on this object, but within the array of errors.
3234
Errors []*Wrapped
3335

3436
// Err is the wrapped error, either the original or already wrapped

0 commit comments

Comments
 (0)