Skip to content

Commit

Permalink
chore: update doc.go to include note about issues with hot paths
Browse files Browse the repository at this point in the history
  • Loading branch information
jsteenb2 committed Mar 17, 2024
1 parent 386899f commit 5200c02
Showing 1 changed file with 5 additions and 1 deletion.
6 changes: 5 additions & 1 deletion doc.go
Original file line number Diff line number Diff line change
Expand Up @@ -3,6 +3,10 @@
// inspired by the [upspin project's error handling](https://github.com/upspin/upspin/blame/master/errors/errors.go)
// and github.com/pkg/errors. It also adds a few lessons learned
// from creating a module like this a number of times across numerous
// projects.
// projects. Worth noting here, this pkg has some limitations, like in
// hot loops. In that case, you may want to use std lib errors or
// similar for the hot loop, then return the result of those with
// this module's error handling with a simple:
// errors.Wrap(hotPathErr)

package errors

0 comments on commit 5200c02

Please sign in to comment.