docs: readme

This commit is contained in:
Marvin Preuss 2021-09-27 11:06:44 +02:00
parent 1983b6bfd0
commit d34ef66014

View File

@ -1,5 +1,5 @@
// Package workgroups is a little helper for creating workers // Package workgroups is a little helper for creating workers
// with the help of sync.Errgroup. // with the help of (sync.Errgroup) https://pkg.go.dev/golang.org/x/sync/errgroup.
// //
// (image/build) https://ci.xsfx.dev/api/badges/xsteadfastx/workgroups/status.svg // (image/build) https://ci.xsfx.dev/api/badges/xsteadfastx/workgroups/status.svg
// (image/coverage) https://codecov.io/gh/xsteadfastx/workgroups/branch/main/graph/badge.svg?token=RZE1ZWJSYA // (image/coverage) https://codecov.io/gh/xsteadfastx/workgroups/branch/main/graph/badge.svg?token=RZE1ZWJSYA
@ -110,6 +110,7 @@ func (d *Dispatcher) Close() {
close(d.queue) close(d.queue)
} }
// Wait for all jobs to finnish.
func (d *Dispatcher) Wait() error { func (d *Dispatcher) Wait() error {
log.Debug().Msg("waiting for jobs to finnish") log.Debug().Msg("waiting for jobs to finnish")