Skip to content

Add note about errors #116

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

Merged
camdencheek merged 2 commits into from
Jun 1, 2023
Merged

Add note about errors #116

Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
3d7472e
add note about errors
camdencheek Jun 1, 2023
5b4c2cc
Merge branch 'main' into cc/add-note-about-errors
camdencheek Jun 1, 2023
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
11 changes: 11 additions & 0 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -455,6 +455,17 @@ func mapStream(
</tr>
</table>

# Errors

In general, `conc` handles multiple errors from tasks by joining them into
a single "multierror". In go 1.19, we use Uber's multierror package, but
in version 1.20, go added native support for joining errors so we use that
instead. Note that, if you are relying on converting an error back into its
component errors, the behavior changes between go 1.19 and go 1.20 and
you should use the `Unwrap() []error` method instead of casting the error
as a `*multierror.Error`. `errors.As` and `errors.Is` should continue
to work as expected.

# Status

This package is currently pre-1.0. There are likely to be minor breaking
Expand Down