From 5802e93a235d138522802764358cb9c7545b3a0e Mon Sep 17 00:00:00 2001 From: Mark Salpeter <marksalpeter@gmail.com> Date: Wed, 14 Apr 2021 12:02:26 +0200 Subject: [PATCH] improvement(docs): including types and funcs --- .github/workflows/version.yml | 2 ++ pipeline.go | 6 +++--- process_example_test.go | 2 +- 3 files changed, 6 insertions(+), 4 deletions(-) diff --git a/.github/workflows/version.yml b/.github/workflows/version.yml index a7440ef..6c007d7 100644 --- a/.github/workflows/version.yml +++ b/.github/workflows/version.yml @@ -44,4 +44,6 @@ jobs: badge-godoc: true badge-goreadme: true badge-goreportcard: true + types: true + functions: true github-token: '${{ secrets.GITHUB_TOKEN }}' \ No newline at end of file diff --git a/pipeline.go b/pipeline.go index 0fa045b..2537742 100644 --- a/pipeline.go +++ b/pipeline.go @@ -1,4 +1,4 @@ -// This package will help you build piplines without worrying about channel management and concurrency. -// It contains common fan-in and fan-out operations as well as useful funcs for batch processing and concurrency. -// If you have another common use case you would like to see covered, please open an [issue](http://github.com/deliveryhero/pipeline) +// Pipeline is a go library for helping you build piplines without worrying about channel management and concurrency. +// It contains common fan-in and fan-out operations as well as useful `func`s for batch processing and concurrency. +// If you have another common use case you would like to see covered, please (open an issue) https://github.com/deliveryhero/pipeline/issues. package pipeline diff --git a/process_example_test.go b/process_example_test.go index 6b3515d..b4bbfb6 100644 --- a/process_example_test.go +++ b/process_example_test.go @@ -40,7 +40,7 @@ func ExampleProcess() { ctx, cancel := context.WithTimeout(context.Background(), 5*time.Second) defer cancel() - // Create a pipeline that emits 1-6 at one int per second + // Create a pipeline that emits 1-6 at a rate of one int per second p := pipeline.Delay(ctx, time.Second, pipeline.Emit(1, 2, 3, 4, 5, 6)) // Use the Multipleir to multiply each int by 10