format docs

docs/content/_index.md

@@ -9,9 +9,11 @@ title: _Underscore
 
 ![underscore](https://socialify.git.ci/rjNemo/underscore/image?description=1&font=KoHo&language=1&logo=https%3A%2F%2Fraw.githubusercontent.com%2FrjNemo%2Funderscore%2Fmain%2Fdocs%2Fstatic%2Flogo.png&owner=1&pattern=Floating%20Cogs&stargazers=1&theme=Dark)
 
-`underscore` is a `Go` library providing useful functional programming helpers without extending any built-in objects.
+`underscore` is a `Go` library providing useful functional programming helpers without
+extending any built-in objects.
 
-It is mostly a port from the `underscore.js` library based on generics available from `go1.18`.
+It is mostly a port from the `underscore.js` library based on generics available
+from `go1.18`.
 
 ## Quick Start
 
@@ -21,25 +23,26 @@ Install the library using
 go get github.com/rjNemo/underscore
 ```
 
-Please check out the [examples](https://github.com/rjNemo/underscore/tree/main/examples) to see how to use the library.
+Please check out the [examples](https://github.com/rjNemo/underscore/tree/main/examples)
+to see how to use the library.
 
 ```go
 package main
 
 import (
-	"fmt"
+ "fmt"
-	u "github.com/rjNemo/underscore"
+ u "github.com/rjNemo/underscore"
 )
 
 func main() {
-	numbers := []int{1, 2, 3, 4, 5, 6, 7, 8, 9}
+ numbers := []int{1, 2, 3, 4, 5, 6, 7, 8, 9}
-	// filter even numbers from the slice
+ // filter even numbers from the slice
-	evens := u.Filter(numbers, func(n int) bool { return n%2 == 0 })
+ evens := u.Filter(numbers, func(n int) bool { return n%2 == 0 })
-	// square every number in the slice
+ // square every number in the slice
-	squares := u.Map(evens, func(n int) int { return n * n })
+ squares := u.Map(evens, func(n int) int { return n * n })
-	// reduce to the sum
+ // reduce to the sum
-	res := u.Reduce(squares, func(n, acc int) int { return n + acc }, 0)
+ res := u.Reduce(squares, func(n, acc int) int { return n + acc }, 0)
 
-	fmt.Println(res) // 120
+ fmt.Println(res) // 120
 }
 ```

docs/content/collections/all.md

@@ -3,7 +3,6 @@ title: "All"
 date: 2021-12-30T13:24:39-04:00
 ---
 
-
 `All` returns true if all the values in the slice pass the predicate truth test.\
 Short-circuits and stops traversing the slice if a false element is found.
 
@@ -11,13 +10,13 @@ Short-circuits and stops traversing the slice if a false element is found.
 package main
 
 import (
-	"fmt"
+ "fmt"
-	u "github.com/rjNemo/underscore"
+ u "github.com/rjNemo/underscore"
 )
 
 func main() {
-	nums := []int{1, 3, 5, 7, 9}
+ nums := []int{1, 3, 5, 7, 9}
-	isOdd := func(n int) bool { return n%2 != 0 }
+ isOdd := func(n int) bool { return n%2 != 0 }
-	fmt.Println(u.All(nums, isOdd)) // true
+ fmt.Println(u.All(nums, isOdd)) // true
 }
 ```

docs/content/collections/any.md

@@ -10,13 +10,13 @@ the slice if a true element is found.
 package main
 
 import (
-	"fmt"
+ "fmt"
-	u "github.com/rjNemo/underscore"
+ u "github.com/rjNemo/underscore"
 )
 
 func main() {
-	nums := []int{1, 2, 4, 6, 8}
+ nums := []int{1, 2, 4, 6, 8}
-	isEven := func(n int) bool { return n%2 == 0 }
+ isEven := func(n int) bool { return n%2 == 0 }
-	fmt.Println(u.Any(nums, isEven)) // true
+ fmt.Println(u.Any(nums, isEven)) // true
 }
 ```

docs/content/collections/contains.md

@@ -9,13 +9,13 @@ date: 2022-03-21T13:30:29-04:00
 package main
 
 import (
-	"fmt"
+ "fmt"
-	u "github.com/rjNemo/underscore"
+ u "github.com/rjNemo/underscore"
 )
 
 func main() {
-	nums := []int{1, 3, 5, 7, 9}
+ nums := []int{1, 3, 5, 7, 9}
 
-	fmt.Println(u.Contains(nums, 5)) // true 
+ fmt.Println(u.Contains(nums, 5)) // true
 }
 ```

docs/content/collections/difference.md

@@ -9,14 +9,14 @@ Returns a copy of the array with all instances of the values that are not presen
 package main
 
 import (
-	"fmt"
+ "fmt"
-	u "github.com/rjNemo/underscore"
+ u "github.com/rjNemo/underscore"
 )
 
 func main() {
-	nums := []int{1, 3, 5, 6, 7, 9}
+ nums := []int{1, 3, 5, 6, 7, 9}
-	reject := []int{9, 7, 5, 4}
+ reject := []int{9, 7, 5, 4}
 
-	fmt.Println(u.Difference(nums, reject)) // {1, 3, 6}
+ fmt.Println(u.Difference(nums, reject)) // {1, 3, 6}
 }
 ```

docs/content/collections/drop.md

@@ -10,13 +10,13 @@ onward.
 package main
 
 import (
-	"fmt"
+ "fmt"
-	u "github.com/rjNemo/underscore"
+ u "github.com/rjNemo/underscore"
 )
 
 func main() {
-	nums := []int{1, 9, 2, 8, 3, 7, 4, 6, 5}
+ nums := []int{1, 9, 2, 8, 3, 7, 4, 6, 5}
 
-	fmt.Println(u.Drop(nums, 3)) // {1, 9, 2, 3, 7, 4, 6, 5}
+ fmt.Println(u.Drop(nums, 3)) // {1, 9, 2, 3, 7, 4, 6, 5}
 }
 ```

docs/content/collections/each.md

@@ -9,17 +9,17 @@ date: 2022-03-21T13:30:59-04:00
 package main
 
 import (
-	"fmt"
+ "fmt"
-	u "github.com/rjNemo/underscore"
+ u "github.com/rjNemo/underscore"
 )
 
 func main() {
-	names := []string{"Alice", "Bob", "Charles"}
+ names := []string{"Alice", "Bob", "Charles"}
-	res := make([]string, 0)
+ res := make([]string, 0)
 
-	u.Each(names, func(n string) {
+ u.Each(names, func(n string) {
-		res = append(res, fmt.Sprintf("Hi %s", n))
+  res = append(res, fmt.Sprintf("Hi %s", n))
-	})
+ })
-	fmt.Println(res) // {"Hi Alice", "Hi Bob", "Hi Charles"} 
+ fmt.Println(res) // {"Hi Alice", "Hi Bob", "Hi Charles"}
 }
 ```

docs/content/collections/filter.md

@@ -9,13 +9,13 @@ date: 2022-03-21T13:31:21-04:00
 package main
 
 import (
-	"fmt"
+ "fmt"
-	u "github.com/rjNemo/underscore"
+ u "github.com/rjNemo/underscore"
 )
 
 func main() {
-	nums := []int{0, 1, 2, 3, 4, 5, 6, 7, 8, 9}
+ nums := []int{0, 1, 2, 3, 4, 5, 6, 7, 8, 9}
-	isEven := func(n int) bool { return n%2 == 0 }
+ isEven := func(n int) bool { return n%2 == 0 }
-	fmt.Println(u.Filter(nums, isEven)) // {0, 2, 4, 6, 8}
+ fmt.Println(u.Filter(nums, isEven)) // {0, 2, 4, 6, 8}
 }
 ```

docs/content/collections/find.md

@@ -11,16 +11,16 @@ element, and doesn't traverse the entire slice.
 package main
 
 import (
-	"fmt"
+ "fmt"
-	u "github.com/rjNemo/underscore"
+ u "github.com/rjNemo/underscore"
 )
 
 func main() {
-	nums := []int{2, 4, 5, 6, 8, 0}
+ nums := []int{2, 4, 5, 6, 8, 0}
-	isOdd := func(n int) bool { return n%2 != 0 }
+ isOdd := func(n int) bool { return n%2 != 0 }
 
-	n, err := u.Find(nums, isOdd)
+ n, err := u.Find(nums, isOdd)
-	fmt.Println(n)   // 5
+ fmt.Println(n)   // 5
-	fmt.Println(err) // nil
+ fmt.Println(err) // nil
 }
 ```

docs/content/collections/flatmap.md

@@ -10,8 +10,8 @@ Flatmap flattens the input slice element into the new slice. FlatMap maps every
 package main
 
 import (
-	"fmt"
+ "fmt"
-	u "github.com/rjNemo/underscore"
+ u "github.com/rjNemo/underscore"
 )
 
 func main() {

docs/content/collections/groupby.md

@@ -9,13 +9,13 @@ GroupBy splits a slice into a map[K][]V grouped by the result of the iterator fu
 package main
 
 import (
-	"fmt"
+ "fmt"
-	u "github.com/rjNemo/underscore"
+ u "github.com/rjNemo/underscore"
 )
 
 func main() {
-  	nums := []float64{1.3, 2.1, 2.4}
+   nums := []float64{1.3, 2.1, 2.4}
-	groupingFunc := func(n float64) int { return int(math.Floor(n)) }
+ groupingFunc := func(n float64) int { return int(math.Floor(n)) }
-  	res := u.GroupBy(nums, groupingFunc) // { 1: {1.3}, 2: {2.1, 2.4}}
+   res := u.GroupBy(nums, groupingFunc) // { 1: {1.3}, 2: {2.1, 2.4}}
 }
 ```

docs/content/collections/intersection.md

@@ -11,8 +11,8 @@ package main
 
 
 import (
-	"fmt"
+ "fmt"
-	u "github.com/rjNemo/underscore"
+ u "github.com/rjNemo/underscore"
 )
 
 func main(){
@@ -22,3 +22,4 @@ func main(){
     fmt.Println(u.Intersection(a, b)) // {3, 5}
 }
 ```
+

docs/content/collections/last.md

@@ -9,13 +9,13 @@ date: 2022-03-21T13:46:24-04:00
 package main
 
 import (
-	"fmt"
+ "fmt"
-	u "github.com/rjNemo/underscore"
+ u "github.com/rjNemo/underscore"
 )
 
 func main() {
-	nums := []int{1, 9, 2, 8, 3, 7, 4, 6, 5}
+ nums := []int{1, 9, 2, 8, 3, 7, 4, 6, 5}
 
-	fmt.Println(u.Last(nums)) // 5
+ fmt.Println(u.Last(nums)) // 5
 }
 ```

docs/content/collections/map.md

@@ -9,15 +9,15 @@ date: 2022-03-21T13:32:10-04:00
 package main
 
 import (
-	"fmt"
+ "fmt"
-	u "github.com/rjNemo/underscore"
+ u "github.com/rjNemo/underscore"
 )
 
 func main() {
-	nums := []int{1, 2, 3}
+ nums := []int{1, 2, 3}
-	toSquare := func(n int) int {
+ toSquare := func(n int) int {
-		return n * n
+  return n * n
-	}
+ }
-	fmt.Println(u.Map(nums, toSquare)) // {1, 4, 9}
+ fmt.Println(u.Map(nums, toSquare)) // {1, 4, 9}
 }
 ```

docs/content/collections/max.md

@@ -10,12 +10,12 @@ uses operator `<`.
 package main
 
 import (
-	"fmt"
+ "fmt"
-	u "github.com/rjNemo/underscore"
+ u "github.com/rjNemo/underscore"
 )
 
 func main() {
-	nums := []int{1, 9, 2, 8, 3, 7, 4, 6, 5}
+ nums := []int{1, 9, 2, 8, 3, 7, 4, 6, 5}
-	fmt.Println(u.Max(nums)) // 9
+ fmt.Println(u.Max(nums)) // 9
 }
 ```

docs/content/collections/min.md

@@ -10,12 +10,12 @@ uses operator `<`.
 package main
 
 import (
-	"fmt"
+ "fmt"
-	u "github.com/rjNemo/underscore"
+ u "github.com/rjNemo/underscore"
 )
 
 func main() {
-	nums := []int{1, 9, 2, 8, 3, 7, 4, 6, 5}
+ nums := []int{1, 9, 2, 8, 3, 7, 4, 6, 5}
-	fmt.Println(u.Min(nums)) // 1
+ fmt.Println(u.Min(nums)) // 1
 }
 ```

docs/content/collections/partition.md

@@ -10,16 +10,16 @@ satisfy predicate.
 package main
 
 import (
-	"fmt"
+ "fmt"
-	u "github.com/rjNemo/underscore"
+ u "github.com/rjNemo/underscore"
 )
 
 func main() {
-	nums := []int{0, 1, 2, 3, 4, 5, 6, 7, 8, 9}
+ nums := []int{0, 1, 2, 3, 4, 5, 6, 7, 8, 9}
-	isEven := func(n int) bool { return n%2 == 0 }
+ isEven := func(n int) bool { return n%2 == 0 }
 
-	evens, odds := u.Partition(nums, isEven)
+ evens, odds := u.Partition(nums, isEven)
-	fmt.Println(evens) // {0, 2, 4, 6, 8}
+ fmt.Println(evens) // {0, 2, 4, 6, 8}
-	fmt.Println(odds)  // {1, 3, 5, 7, 9}
+ fmt.Println(odds)  // {1, 3, 5, 7, 9}
 }
 ```

docs/content/collections/reduce.md

@@ -10,13 +10,13 @@ be returned by the reduction function.
 package main
 
 import (
-	"fmt"
+ "fmt"
-	u "github.com/rjNemo/underscore"
+ u "github.com/rjNemo/underscore"
 )
 
 func main() {
-	nums := []int{0, 1, 2, 3, 4, 5, 6, 7, 8, 9}
+ nums := []int{0, 1, 2, 3, 4, 5, 6, 7, 8, 9}
-	sum := func(n, acc int) int { return n + acc }
+ sum := func(n, acc int) int { return n + acc }
-	fmt.Println(u.Reduce(nums, sum, 0)) // 45
+ fmt.Println(u.Reduce(nums, sum, 0)) // 45
 }
 ```

docs/content/collections/sum.md

@@ -9,13 +9,13 @@ date: 2022-03-21T13:50:29-04:00
 package main
 
 import (
-	"fmt"
+ "fmt"
-	u "github.com/rjNemo/underscore"
+ u "github.com/rjNemo/underscore"
 )
 
 func main() {
-	nums := []int{0, 1, 2, 3, 4, 5, 6, 7, 8, 9}
+ nums := []int{0, 1, 2, 3, 4, 5, 6, 7, 8, 9}
 
-	fmt.Println(u.Sum(nums)) // 45
+ fmt.Println(u.Sum(nums)) // 45
 }
 ```

docs/content/collections/unique.md

@@ -9,13 +9,13 @@ date: 2022-04-12T17:18:04-04:00
 package main
 
 import (
-	"fmt"
+ "fmt"
-	u "github.com/rjNemo/underscore"
+ u "github.com/rjNemo/underscore"
 )
 
 func main() {
-	nums := []int{1, 4, 2, 5, 3, 1, 5, 2, 8, 9}
+ nums := []int{1, 4, 2, 5, 3, 1, 5, 2, 8, 9}
 
-	fmt.Println(u.Unique(nums)) // 1, 4, 2, 5, 3, 8, 9
+ fmt.Println(u.Unique(nums)) // 1, 4, 2, 5, 3, 8, 9
 }
 ```

docs/content/pipe/new_pipe.md

@@ -3,29 +3,30 @@ title: "NewPipe"
 date: 2021-12-31T13:11:41-04:00
 ---
 
+Calling `NewPipe` will cause all future method calls to return wrapped objects.
+When you've finished the computation, call `Value` to retrieve the final value.
 
-Calling `NewPipe` will cause all future method calls to return wrapped objects. When you've finished the computation,
+Methods not returning a collection such as `Reduce`, `All`, `Any`, will break the
-call `Value` to retrieve the final value.
+chain and return `Value` instantly.
-
-Methods not returning a collection such as `Reduce`, `All`, `Any`, will break the chain and return `Value` instantly.
 
 ```go
 package main
 
 import (
-	"fmt"
+ "fmt"
-	u "github.com/rjNemo/underscore"
+ u "github.com/rjNemo/underscore"
 )
 
 func main() {
-	sum := u.NewPipe([]int{1, 2, 3, 4, 5, 6, 7, 8, 9}).
+ sum := u.NewPipe([]int{1, 2, 3, 4, 5, 6, 7, 8, 9}).
-		// filter even numbers from the slice
+  // filter even numbers from the slice
-		Filter(func(n int) bool { return n%2 == 0 }).
+  Filter(func(n int) bool { return n%2 == 0 }).
-		// square every number in the slice
+  // square every number in the slice
-		Map(func(n int) int { return n * n }).
+  Map(func(n int) int { return n * n }).
-		// reduce to the sum
+  // reduce to the sum
-		Reduce(func(n, acc int) int { return n + acc }, 0)
+  Reduce(func(n, acc int) int { return n + acc }, 0)
 
-	fmt.Println(sum) // 120
+ fmt.Println(sum) // 120
 }
 ```
+

docs/content/usage/start.md

@@ -11,38 +11,40 @@ Install the library using
 go get github.com/rjNemo/underscore
 ```
 
-Please check out the [examples](https://github.com/rjNemo/underscore/tree/main/examples) to see how to use the library.
+Please check out the [examples](https://github.com/rjNemo/underscore/tree/main/examples)
+to see how to use the library.
 
 ```go
 package main
 
 import (
-	"fmt"
+ "fmt"
-	u "github.com/rjNemo/underscore"
+ u "github.com/rjNemo/underscore"
 )
 
 func main() {
-	numbers := []int{1, 2, 3, 4, 5, 6, 7, 8, 9}
+ numbers := []int{1, 2, 3, 4, 5, 6, 7, 8, 9}
-	// filter even numbers from the slice
+ // filter even numbers from the slice
-	evens := u.Filter(numbers, func(n int) bool { return n%2 == 0 })
+ evens := u.Filter(numbers, func(n int) bool { return n%2 == 0 })
-	// square every number in the slice
+ // square every number in the slice
-	squares := u.Map(evens, func(n int) int { return n * n })
+ squares := u.Map(evens, func(n int) int { return n * n })
-	// reduce to the sum
+ // reduce to the sum
-	res := u.Reduce(squares, func(n, acc int) int { return n + acc }, 0)
+ res := u.Reduce(squares, func(n, acc int) int { return n + acc }, 0)
 
-	fmt.Println(res) // 120
+ fmt.Println(res) // 120
 }
 ```
 
 ## Installation
 
-These instructions will get you a copy of the project up and running on your local machine for development and testing
+These instructions will get you a copy of the project up and running on your local
-purposes.
+machine for development and testing purposes.
 
 ### Prerequisites
 
 You need at least `go1.18` for development. The project is shipped with
-a [Dockerfile](https://github.com/rjNemo/underscore/tree/main/Dockerfile) based on `go1.18`.
+a [Dockerfile](https://github.com/rjNemo/underscore/tree/main/Dockerfile) based
+on `go1.18`.
 
 If you prefer local development, navigate to the [official
 download page](https://go.dev/dl/) and install version `1.18` or beyond.