Skip to content

Commit

Permalink
improvement(docs): updated docs
Browse files Browse the repository at this point in the history
  • Loading branch information
marksalpeter committed Jun 29, 2021
1 parent 87f2017 commit de00a95
Showing 1 changed file with 8 additions and 4 deletions.
12 changes: 8 additions & 4 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -157,7 +157,7 @@ func main() {

```

### func [Process](/process.go#L12)
### func [Process](/process.go#L13)

`func Process(ctx context.Context, processor Processor, in <-chan interface{}) <-chan interface{}`

Expand Down Expand Up @@ -206,7 +206,7 @@ func main() {

```

### func [ProcessBatch](/process_batch.go#L13)
### func [ProcessBatch](/process_batch.go#L14)

`func ProcessBatch(
ctx context.Context,
Expand Down Expand Up @@ -257,7 +257,7 @@ func main() {

```

### func [ProcessBatchConcurrently](/process_batch.go#L30)
### func [ProcessBatchConcurrently](/process_batch.go#L35)

`func ProcessBatchConcurrently(
ctx context.Context,
Expand Down Expand Up @@ -313,7 +313,7 @@ func main() {

```

### func [ProcessConcurrently](/process.go#L23)
### func [ProcessConcurrently](/process.go#L26)

`func ProcessConcurrently(ctx context.Context, concurrently int, p Processor, in <-chan interface{}) <-chan interface{}`

Expand Down Expand Up @@ -379,5 +379,9 @@ Processor represents a blocking operation in a pipeline. Implementing `Processor
business logic to your pipelines without directly managing channels. This simplifies your unit tests
and eliminates channel management related bugs.

## Sub Packages

* [semaphore](./semaphore): package semaphore is like a sync.WaitGroup with an upper limit.

---
Readme created from Go doc with [goreadme](https://github.com/posener/goreadme)

0 comments on commit de00a95

Please sign in to comment.