update doc

Author: shalldie

gs/README.md

@@ -98,8 +98,8 @@ index5 := gs.LastIndexOf(list, 5)
 Determines whether all the members of a slice satisfy the specified test.
 
 ```go
-allless4 := gs.Every([]int{1, 2, 3}, func(t, i int) bool {
-    return t < 4
+allless4 := gs.Every([]int{1, 2, 3}, func(item, index int) bool {
+    return item < 4
 })
 // true
 ```
@@ -109,8 +109,8 @@ allless4 := gs.Every([]int{1, 2, 3}, func(t, i int) bool {
 Determines whether the specified callback function returns true for any element of a slice.
 
 ```go
-hasEven := gs.Some([]int{5, 6, 7}, func(t, i int) bool {
-    return t%2 == 0
+hasEven := gs.Some([]int{5, 6, 7}, func(item, index int) bool {
+    return item%2 == 0
 })
 // true
 ```
@@ -120,19 +120,18 @@ hasEven := gs.Some([]int{5, 6, 7}, func(t, i int) bool {
 Performs the specified action for each element in a slice.
 
 ```go
-gs.ForEach([]int{1, 2, 3}, func(t int, i int) {
-    println(t)
+gs.ForEach([]int{1, 2, 3}, func(item, index int) {
+    println(item)
 })
-
 ```
 
 ### Map
 
 Calls a defined callback function on each element of a slice, and returns a slice that contains the results.
 
 ```go
-list := gs.Map([]int{5, 6, 7}, func(t int, i int) string {
-    return strconv.Itoa(t)
+list := gs.Map([]int{5, 6, 7}, func(item, index int) string {
+    return strconv.Itoa(item)
 })
 // ["5" "6" "7"]
 ```
@@ -142,8 +141,8 @@ list := gs.Map([]int{5, 6, 7}, func(t int, i int) string {
 Returns the elements of a slice that meet the condition specified in a callback function.
 
 ```go
-list = gs.Filter([]int{1, 2, 3, 4, 5, 6, 7, 8}, func(t, i int) bool {
-    return t%2 == 0
+list = gs.Filter([]int{1, 2, 3, 4, 5, 6, 7, 8}, func(item, index int) bool {
+    return item%2 == 0
 })
 // [2 4 6 8]
 ```
@@ -153,8 +152,8 @@ list = gs.Filter([]int{1, 2, 3, 4, 5, 6, 7, 8}, func(t, i int) bool {
 Calls the specified callback function for all the elements in a slice. The return value of the callback function is the accumulated result, and is provided as an argument in the next call to the callback function.
 
 ```go
-sum := gs.Reduce([]int{1, 2, 3}, func(r int, t int, i int) int {
-    return r + t
+sum := gs.Reduce([]int{1, 2, 3}, func(previousValue int, currentValue int, currentIndex int) int {
+    return previousValue + currentValue
 }, 0)
 // 6
 ```
@@ -164,8 +163,8 @@ sum := gs.Reduce([]int{1, 2, 3}, func(r int, t int, i int) int {
 Returns the index of the first element in the slice that satisfies the provided testing function. Otherwise, it returns -1
 
 ```go
-index := gs.FindIndex([]int{1, 2, 3}, func(t, i int) bool {
-    return t%2 == 0
+index := gs.FindIndex([]int{1, 2, 3}, func(item, index int) bool {
+    return item%2 == 0
 })
 // 1
 ```
@@ -175,12 +174,12 @@ index := gs.FindIndex([]int{1, 2, 3}, func(t, i int) bool {
 Returns the value of the first element in the provided slice that satisfies the provided testing function.
 
 ```go
-item, err := gs.Find([]int{1, 2, 3}, func(t, i int) bool {
-    return t%2 == 0
+target, err := gs.Find([]int{1, 2, 3}, func(item, index int) bool {
+    return item%2 == 0
 })
 
 if err != nil {
-    println(item)
+    println(target)
     // 2
 }
 ```

gs/README.zh-CN.md

@@ -98,8 +98,8 @@ index5 := gs.LastIndexOf(list, 5)
 测试一个 `slice` 内的所有元素是否都能通过某个指定函数的测试。
 
 ```go
-allless4 := gs.Every([]int{1, 2, 3}, func(t, i int) bool {
-    return t < 4
+allless4 := gs.Every([]int{1, 2, 3}, func(item, index int) bool {
+    return item < 4
 })
 // true
 ```
@@ -109,8 +109,8 @@ allless4 := gs.Every([]int{1, 2, 3}, func(t, i int) bool {
 测试 `slice` 中是不是至少有 1 个元素通过了被提供的函数测试。
 
 ```go
-hasEven := gs.Some([]int{5, 6, 7}, func(t, i int) bool {
-    return t%2 == 0
+hasEven := gs.Some([]int{5, 6, 7}, func(item, index int) bool {
+    return item%2 == 0
 })
 // true
 ```
@@ -120,19 +120,18 @@ hasEven := gs.Some([]int{5, 6, 7}, func(t, i int) bool {
 对 `slice` 的每个元素执行一次给定的函数。
 
 ```go
-gs.ForEach([]int{1, 2, 3}, func(t int, i int) {
-    println(t)
+gs.ForEach([]int{1, 2, 3}, func(item, index int) {
+    println(item)
 })
-
 ```
 
 ### Map
 
 创建一个新 `slice` ，其结果是该 `slice` 中的每个元素是调用一次提供的函数后的返回值。
 
 ```go
-list := gs.Map([]int{5, 6, 7}, func(t int, i int) string {
-    return strconv.Itoa(t)
+list := gs.Map([]int{5, 6, 7}, func(item, index int) string {
+    return strconv.Itoa(item)
 })
 // ["5" "6" "7"]
 ```
@@ -142,8 +141,8 @@ list := gs.Map([]int{5, 6, 7}, func(t int, i int) string {
 创建一个新 `slice` , 其包含通过所提供函数实现的测试的所有元素。
 
 ```go
-list = gs.Filter([]int{1, 2, 3, 4, 5, 6, 7, 8}, func(t, i int) bool {
-    return t%2 == 0
+list = gs.Filter([]int{1, 2, 3, 4, 5, 6, 7, 8}, func(item, index int) bool {
+    return item%2 == 0
 })
 // [2 4 6 8]
 ```
@@ -153,8 +152,8 @@ list = gs.Filter([]int{1, 2, 3, 4, 5, 6, 7, 8}, func(t, i int) bool {
 对 `slice` 中的每个元素执行一个由您提供的 reducer 函数(升序执行)，将其结果汇总为单个返回值。
 
 ```go
-sum := gs.Reduce([]int{1, 2, 3}, func(r int, t int, i int) int {
-    return r + t
+sum := gs.Reduce([]int{1, 2, 3}, func(previousValue int, currentValue int, currentIndex int) int {
+    return previousValue + currentValue
 }, 0)
 // 6
 ```
@@ -164,8 +163,8 @@ sum := gs.Reduce([]int{1, 2, 3}, func(r int, t int, i int) int {
 返回 `slice` 中满足提供的测试函数的第一个元素的索引。若没有找到对应元素则返回-1。
 
 ```go
-index := gs.FindIndex([]int{1, 2, 3}, func(t, i int) bool {
-    return t%2 == 0
+index := gs.FindIndex([]int{1, 2, 3}, func(item, index int) bool {
+    return item%2 == 0
 })
 // 1
 ```
@@ -175,12 +174,12 @@ index := gs.FindIndex([]int{1, 2, 3}, func(t, i int) bool {
 返回 `slice` 中满足提供的测试函数的第一个元素的值。
 
 ```go
-item, err := gs.Find([]int{1, 2, 3}, func(t, i int) bool {
-    return t%2 == 0
+target, err := gs.Find([]int{1, 2, 3}, func(item, index int) bool {
+    return item%2 == 0
 })
 
 if err != nil {
-    println(item)
+    println(target)
     // 2
 }
 ```

gs/gs_test.go

@@ -62,14 +62,14 @@ func TestEvery(t *testing.T) {
 	list := []int{1, 2, 3}
 
 	assert.True(
-		Every(list, func(t, i int) bool {
-			return t < 4
+		Every(list, func(item, index int) bool {
+			return item < 4
 		}),
 	)
 
 	assert.False(
-		Every(list, func(t, i int) bool {
-			return t < 3
+		Every(list, func(item, index int) bool {
+			return item < 3
 		}),
 	)
 }