go-pkgz / flow

87%

master: 91%

LAST BUILD ON BRANCH fix-readme-pool-docs

branch: fix-readme-pool-docs

CHANGE BRANCH

x

Reset

• fix-readme-pool-docs
• ci-lift
• ci-workflow-permissions
• deps-update
• fix-ci-caching
• fix-submit-concurrency
• fix-wait-deadlock
• master
• modernise-go-fix
• pool
• rbac
• refs/tags/v1.2.0
• refs/tags/v1.3.0
• refs/tags/v1.3.1
• refs/tags/v1.3.2
• refs/tags/v1.3.3
• refs/tags/v1.3.4
• refs/tags/v1.3.5
• stabilise-flow-tests
• sync-read
• v1.0.0
• v1.1.1

Build # 32218043098

Build Type

Pull #9

github

Committed by paskal

Commit Message

fix pool section of README

The pool examples did not compile: workerFn signature closed with a brace,
pool.Sender instead of pool.SenderFn, sendFn called with two arguments,
a three-value return from an error function and cursor called as a func
instead of cursor.Next. Option names and defaults were wrong as well,
ChanResSize and ChanWorkerSize do not exist and both channels are
unbuffered by default.

Also corrects what the section claims: the pool is started with the same
context the cursor is read with, All is shown as an alternative to the
Next loop rather than a follow-up to it, WorkerStore is described as
worker-local instead of thread-safe, and OnCompletion as running only for
workers whose input closed normally.

Pull Request Pull Request #9: fix pool section of README

Coverage Stats

166 of 190 relevant lines covered (87.37%)

119.43 hits per line