feat: add go style doc

Author: repeale

README.md

@@ -223,6 +223,8 @@ Pipe2(fp.Filter(isPositive), fp.Map(sumTwo))([]int{1, 2, 3, -1})
 
 #### Curry
 
+Allow to transfrom a function that receives a certain amount of params in single functions that take one single param each.
+
 Variations `Curry2`, `Curry3` and `Curry4` stating the number of params will be curried individually.
 
 ```go

compose.go

@@ -1,17 +1,20 @@
 package fp
 
+// Performs right-to-left function composition of two functions
 func Compose2[T1, T2, R any](fn2 func(T2) R, fn1 func(T1) T2) func(T1) R {
 	return func(t1 T1) R {
 		return fn2(fn1(t1))
 	}
 }
 
+// Performs right-to-left function composition of three functions
 func Compose3[T1, T2, T3, R any](fn3 func(T3) R, fn2 func(T2) T3, fn1 func(T1) T2) func(T1) R {
 	return func(t1 T1) R {
 		return fn3(fn2(fn1(t1)))
 	}
 }
 
+// Performs right-to-left function composition of four functions
 func Compose4[T1, T2, T3, T4, R any](fn4 func(T4) R, fn3 func(T3) T4, fn2 func(T2) T3, fn1 func(T1) T2) func(T1) R {
 	return func(t1 T1) R {
 		return fn4(fn3(fn2(fn1(t1))))

curry.go

@@ -1,5 +1,6 @@
 package fp
 
+// Allow to transfrom a function that receives two params in single functions that take one single param each
 func Curry2[T1, T2, R any](fn func(T1, T2) R) func(T1) func(T2) R {
 	return func(t1 T1) func(T2) R {
 		return func(t2 T2) R {
@@ -8,6 +9,7 @@ func Curry2[T1, T2, R any](fn func(T1, T2) R) func(T1) func(T2) R {
 	}
 }
 
+// Like Curry2 but with three params
 func Curry3[T1, T2, T3, R any](fn func(T1, T2, T3) R) func(T1) func(T2) func(T3) R {
 	return func(t1 T1) func(T2) func(T3) R {
 		return func(t2 T2) func(T3) R {
@@ -18,6 +20,7 @@ func Curry3[T1, T2, T3, R any](fn func(T1, T2, T3) R) func(T1) func(T2) func(T3)
 	}
 }
 
+// Like Curry2 but with four params
 func Curry4[T1, T2, T3, T4, R any](fn func(T1, T2, T3, T4) R) func(T1) func(T2) func(T3) func(T4) R {
 	return func(t1 T1) func(T2) func(T3) func(T4) R {
 		return func(t2 T2) func(T3) func(T4) R {

every.go

@@ -14,6 +14,7 @@ func Every[T any](predicate func(T) bool) func([]T) bool {
 	}
 }
 
+// See Every but callback receives index of element.
 func EveryWithIndex[T any](predicate func(T, int) bool) func([]T) bool {
 	return func(xs []T) bool {
 
@@ -27,6 +28,7 @@ func EveryWithIndex[T any](predicate func(T, int) bool) func([]T) bool {
 	}
 }
 
+// Like Every but callback receives index of element and the whole array.
 func EveryWithSlice[T any](predicate func(T, int, []T) bool) func([]T) bool {
 	return func(xs []T) bool {
 

filter.go

@@ -16,6 +16,7 @@ func Filter[T any](predicate func(T) bool) func([]T) []T {
 	}
 }
 
+// See Filter but callback receives index of element.
 func FilterWithIndex[T any](predicate func(T, int) bool) func([]T) []T {
 	return func(xs []T) []T {
 
@@ -31,6 +32,7 @@ func FilterWithIndex[T any](predicate func(T, int) bool) func([]T) []T {
 	}
 }
 
+// Like Filter but callback receives index of element and the whole array.
 func FilterWithSlice[T any](predicate func(T, int, []T) bool) func([]T) []T {
 	return func(xs []T) []T {
 

flatMap.go

@@ -14,6 +14,7 @@ func FlatMap[T any, R any](callback func(T) []R) func([]T) []R {
 	}
 }
 
+// See FlatMap but callback receives index of element.
 func FlatMapWithIndex[T any, R any](callback func(T, int) []R) func([]T) []R {
 	return func(xs []T) []R {
 
@@ -27,6 +28,7 @@ func FlatMapWithIndex[T any, R any](callback func(T, int) []R) func([]T) []R {
 	}
 }
 
+// Like FlatMap but callback receives index of element and the whole array.
 func FlatMapWithSlice[T any, R any](callback func(T, int, []T) []R) func([]T) []R {
 	return func(xs []T) []R {
 

map.go

@@ -14,6 +14,7 @@ func Map[T any, R any](callback func(T) R) func([]T) []R {
 	}
 }
 
+// See Map but callback receives index of element.
 func MapWithIndex[T any, R any](callback func(T, int) R) func([]T) []R {
 	return func(xs []T) []R {
 
@@ -27,6 +28,7 @@ func MapWithIndex[T any, R any](callback func(T, int) R) func([]T) []R {
 	}
 }
 
+// Like Map but callback receives index of element and the whole array.
 func MapWithSlice[T any, R any](callback func(T, int, []T) R) func([]T) []R {
 	return func(xs []T) []R {
 

pipe.go

@@ -1,17 +1,20 @@
 package fp
 
+// Performs left-to-right function composition of two functions
 func Pipe2[T1, T2, R any](fn1 func(T1) T2, fn2 func(T2) R) func(T1) R {
 	return func(t1 T1) R {
 		return fn2(fn1(t1))
 	}
 }
 
+// Performs left-to-right function composition of three functions
 func Pipe3[T1, T2, T3, R any](fn1 func(T1) T2, fn2 func(T2) T3, fn3 func(T3) R) func(T1) R {
 	return func(t1 T1) R {
 		return fn3(fn2(fn1(t1)))
 	}
 }
 
+// Performs left-to-right function composition of four functions
 func Pipe4[T1, T2, T3, T4, R any](fn1 func(T1) T2, fn2 func(T2) T3, fn3 func(T3) T4, fn4 func(T4) R) func(T1) R {
 	return func(t1 T1) R {
 		return fn4(fn3(fn2(fn1(t1))))

reduce.go

@@ -12,6 +12,7 @@ func Reduce[T any, R any](callback func(R, T) R, acc R) func([]T) R {
 	}
 }
 
+// See Reduce but callback receives index of element.
 func ReduceWithIndex[T any, R any](callback func(R, T, int) R, acc R) func([]T) R {
 	return func(xs []T) R {
 
@@ -23,6 +24,7 @@ func ReduceWithIndex[T any, R any](callback func(R, T, int) R, acc R) func([]T)
 	}
 }
 
+// Like Reduce but callback receives index of element and the whole array.
 func ReduceWithSlice[T any, R any](callback func(R, T, int, []T) R, acc R) func([]T) R {
 	return func(xs []T) R {
 

some.go

@@ -14,6 +14,7 @@ func Some[T any](predicate func(T) bool) func([]T) bool {
 	}
 }
 
+// See Some but callback receives index of element.
 func SomeWithIndex[T any](predicate func(T, int) bool) func([]T) bool {
 	return func(xs []T) bool {
 
@@ -27,6 +28,7 @@ func SomeWithIndex[T any](predicate func(T, int) bool) func([]T) bool {
 	}
 }
 
+// Like Some but callback receives index of element and the whole array.
 func SomeWithSlice[T any](predicate func(T, int, []T) bool) func([]T) bool {
 	return func(xs []T) bool {