xsteadfastx/workgroups
1
0
Fork 0
Code Issues Pull Requests Projects Releases 7 Wiki Activity

docs: updates readme
All checks were successful
ci/woodpecker/push/woodpecker Pipeline was successful
Details
ci/woodpecker/tag/woodpecker Pipeline was successful
Details

Browse Source
This commit is contained in:
Marvin Preuss 2022-05-17 13:48:16 +02:00
parent 83d1e50fd1
commit 5c2379c6d3
1 changed files with 3 additions and 3 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

6
README.md
View File

@ -34,13 +34,13 @@ var ErrInWorker = errors.New("received error in worker")
Dispatcher carries the job queue, the errgroup and the number of workers Dispatcher carries the job queue, the errgroup and the number of workers
to start. to start.
#### func (*Dispatcher) [Append](/workgroups.go#L113) #### func (*Dispatcher) [Append](/workgroups.go#L114)
`func (d *Dispatcher) Append(job Job)` `func (d *Dispatcher) Append(job Job)`
Append adds a job to the work queue. Append adds a job to the work queue.
#### func (*Dispatcher) [Close](/workgroups.go#L119) #### func (*Dispatcher) [Close](/workgroups.go#L120)
`func (d *Dispatcher) Close()` `func (d *Dispatcher) Close()`
@ -52,7 +52,7 @@ Close closes the queue channel.
Start starts the configured number of workers and waits for jobs. Start starts the configured number of workers and waits for jobs.
#### func (*Dispatcher) [Wait](/workgroups.go#L125) #### func (*Dispatcher) [Wait](/workgroups.go#L126)
`func (d *Dispatcher) Wait() error` `func (d *Dispatcher) Wait() error`