Skip to content

Commit

Permalink
README.md: add a table of contents
Browse files Browse the repository at this point in the history
  • Loading branch information
creachadair committed Sep 12, 2024
1 parent 934305f commit 56ad314
Showing 1 changed file with 11 additions and 0 deletions.
11 changes: 11 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -12,6 +12,15 @@ for common concurrent tasks.

Here is a [working example in the Go Playground](https://go.dev/play/p/wCZzMDXRUuM).

## Contents

- [Rationale](#rationale)
- [Overview](#overview)
- [Filtering Errors](#filtering-errors)
- [Controlling Concurrency](#controlling-concurrency)
- [Solo Tasks](#solo-tasks)
- [Collecting Results](#collecting-results)

## Rationale

Go provides powerful concurrency primitives, including
Expand Down Expand Up @@ -172,6 +181,8 @@ A group does not directly support cancellation, but integrates cleanly with the
standard [context](https://godoc.org/context) package. A `context.CancelFunc`
can be used as a trigger to signal the whole group when an error occurs.

## Overview

A task is expressed as a `func() error`, and is added to a group using the `Go`
method:

Expand Down

0 comments on commit 56ad314

Please sign in to comment.