Readme and docs (#53)

* demonstrate typed slog

* remove references to ErrorGroup

---------

Co-authored-by: Greg Weber <[email protected]>

README.md

@@ -25,7 +25,9 @@ If you don't want to bother with adding any additional metadata, you can just us
 You can also add context with slog attributes with `Wraps`
 
 ```go
-return errors.Wraps(err, "failure", "id", 5, "key", "value)
+return errors.Wraps(err, "failure message", slog.Int("id", 5), slog.String("key", "value))
+// or untyped just as in slog
+return errors.Wraps(err, "failure message", "id", 5, "key", "value)
 ```
 
 ## Using with standard library errors

errwrap/go_123.go

@@ -7,7 +7,7 @@ import (
 )
 
 // UnwrapGroups will unwrap errors visiting each one.
-// Any ErrorGroup is expanded and traversed
+// An error that defines Unwrap() []error is expanded and traversed
 // This is a depth-first traversal, doing the unwrap first and the expansion second.
 // This can be used for functionality similar to errors.As but it also expands error groups.
 func UnwrapGroups(err error) iter.Seq[error] {

errwrap/wrap.go

@@ -235,7 +235,7 @@ func writeString(w io.Writer, s string) {
 // UnwrapGroups is now preferred for those using Go version >= 1.23.
 // Note that WalkDeep uses the opposite convention for boolean return values compared to golang iterators.
 // WalkDeep does a depth-first traversal of all errors.
-// Any ErrorGroup is traversed (after first unwrapping deeply).
+// An error that defines Unwrap() []error is expanded and traversed
 // The visitor function can return true to end the traversal early
 // If iteration is ended early, WalkDeep will return true, otherwise false.
 func WalkDeep(err error, visitor func(err error) bool) bool {