Skip to content

Commit

Permalink
improvement(docs): including types and funcs
Browse files Browse the repository at this point in the history
  • Loading branch information
marksalpeter committed Apr 14, 2021
1 parent 15acfa1 commit 5802e93
Show file tree
Hide file tree
Showing 3 changed files with 6 additions and 4 deletions.
2 changes: 2 additions & 0 deletions .github/workflows/version.yml
Original file line number Diff line number Diff line change
Expand Up @@ -44,4 +44,6 @@ jobs:
badge-godoc: true
badge-goreadme: true
badge-goreportcard: true
types: true
functions: true
github-token: '${{ secrets.GITHUB_TOKEN }}'
6 changes: 3 additions & 3 deletions pipeline.go
Original file line number Diff line number Diff line change
@@ -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
2 changes: 1 addition & 1 deletion process_example_test.go
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand Down

0 comments on commit 5802e93

Please sign in to comment.