Skip to content

Update documentation and replace the deprecated function Wrap with Augment #38

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
papasavva wants to merge 1 commit into
base: master
Choose a base branch
from
Open

Update documentation and replace the deprecated function Wrap with Augment #38

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
5 changes: 3 additions & 2 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -11,10 +11,11 @@ Terrors is built and used at [Monzo](https://monzo.com/).

## Usage

Terrors can be used to wrap any object that satisfies the error interface:
Terrors can be used to add context to an existing error that satisfies the error interface:


```go
terr := terrors.Wrap(err, map[string]string{"context": "my_context"})
terr := terrors.Augment(err, "Message", map[string]string{"context": "my_context"})
```
Terrors can be instantiated directly:

Expand Down