Skip to content

Commit 2c2ade5

Browse files
author
liuqiangqiang
committed
chore: update doc
1 parent 573d2d6 commit 2c2ade5

File tree

2 files changed

+5
-9
lines changed

2 files changed

+5
-9
lines changed

README.md

+4-5
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,9 @@
11
# Flow
22
🌊Flow is an easy-used concurrent calculate model in Go.
3+
34
Flow can easily limit the maxium number of concurrent goroutine and can be very straight-forward to use.
4-
Basically, flow is a 2d matrix and it runs jobs row-by-row and all the jobs in same row will run concurrently.
5+
6+
Basically, flow is a 2D matrix and it run jobs row-by-row which in same row, the jobs will run concurrently.
57

68
# Example
79
```Go
@@ -20,10 +22,7 @@ func main() {
2022
counter++
2123
fmt.Println("level", counter)
2224
}
23-
// Next start a new level, and put the job `showLevel` in this level
24-
// the first level will be created by Flow
25-
// so you can also use With to add showLevel in the first level
26-
// f.With(showLevel)
25+
// Next starts a new level, and put the job `showLevel` in it
2726
f.Next(showLevel)
2827
for i := 0; i < 20; i++ {
2928
v := i

flow_test.go

+1-4
Original file line numberDiff line numberDiff line change
@@ -14,10 +14,7 @@ func Example() {
1414
counter++
1515
fmt.Println("level", counter)
1616
}
17-
// Next start a new level, and put the func `showLevel` in this level
18-
// the first level will be created by Flow
19-
// so you can also use With to add showLevel in the first level
20-
// f.With(showLevel)
17+
// Next starts a new level, and put the job `showLevel` in it
2118
f.Next(showLevel)
2219
for i := 0; i < 20; i++ {
2320
v := i

0 commit comments

Comments
 (0)