updates docs

Author: adam-hanna

arrayOperations.go

@@ -7,8 +7,7 @@ package go2
 // 	func isEven(i int) bool {
 // 	  return i % 2 == 0
 // 	}
-// 	el := FindOne(arr, isEven)
-// 	fmt.Println(el)
+// 	fmt.Println(FindOne[int](arr, isEven))
 // 	// output: [2]
 func FindOne[T any](arr []T, guard func(T) bool) (T, bool) {
 	for idx := range arr {
@@ -33,9 +32,8 @@ func FindOne[T any](arr []T, guard func(T) bool) (T, bool) {
 // 	  state[animal] = count + 1
 // 	  return state
 // 	}
-// 	initialState := make([string]int)
-// 	finalState := Reduce(arr, countAnimals, initialState)
-// 	fmt.Println(finalState)
+// 	initialState := make(map[string]int)
+// 	fmt.Println(Reduce[string, map[string]int](arr, countAnimals, initialState))
 // 	// output: map["cat":2 "dog":1 "cow":1]
 func Reduce[T, A any](arr []T, fn func(A, T) A, init A) A {
 	ret := init
@@ -53,8 +51,7 @@ func Reduce[T, A any](arr []T, fn func(A, T) A, init A) A {
 // 	func isEven(i int) bool {
 // 	  return i % 2 == 0
 // 	}
-// 	newArr := Filter(arr, isEven)
-// 	fmt.Println(newArr)
+// 	fmt.Println(Filter[int](arr, isEven))
 // 	// output: [0,2,4]
 func Filter[T any](arr []T, guard func(T) bool) []T {
 	var ret []T
@@ -74,8 +71,7 @@ func Filter[T any](arr []T, guard func(T) bool) []T {
 // 	func addTen(i int) int {
 // 	  return i + 10
 // 	}
-// 	newArr := Map(arr, addTen)
-// 	fmt.Println(newArr)
+// 	fmt.Println(Map[int](arr, addTen))
 // 	// output: [11, 12, 13]
 func Map[T any](arr []T, transform func(T) T) []T {
 	ret := make([]T, len(arr))
@@ -89,10 +85,8 @@ func Map[T any](arr []T, transform func(T) T) []T {
 
 // Distinct returns the unique vals of a slice
 //
-// 	a := []int{1, 1, 2, 3}
-// 	b := Distinct[int](a)
-// 	fmt.Println(b)
-// 	output: [1, 2, 3]
+// 	fmt.Println(Distinct[int]([]int{1, 1, 2, 3}))
+// 	// output: [1, 2, 3]
 func Distinct[T comparable](arrs ...[]T) []T {
 	// put the values of our slice into a map
 	// the key's of the map will be the slice's unique values
@@ -116,9 +110,15 @@ func Distinct[T comparable](arrs ...[]T) []T {
 
 // Intersect returns a slice of values that are present in all of the input slices
 //
-// [1, 1, 3, 4, 5, 6] & [2, 3, 6] >> [3, 6]
+//  // example #1
+//  a := []int{1, 1, 3, 4, 5, 6}
+//  b := []int{2, 3, 6} 
+//  fmt.Println(Intersect[int](a, b))
+//  // output: []int{3, 6}
 //
-// [1, 1, 3, 4, 5, 6] >> [1, 3, 4, 5, 6]
+//  // example #2
+//  fmt.Println(Intersect[int]([]int{1, 1, 3, 4, 5, 6}))
+//  // output: []int{1, 3, 4, 5, 6}
 func Intersect[T comparable](arrs ...[]T) []T {
 	m := make(map[T]int)
 
@@ -155,9 +155,15 @@ func Intersect[T comparable](arrs ...[]T) []T {
 
 // Union returns a slice that contains the unique values of all the input slices
 //
-// [1, 2, 2, 4, 6] & [2, 4, 5] >> [1, 2, 4, 5, 6]
+//  // example #1
+//  a := []int{1, 2, 2, 4, 6}
+//  b := []int{2, 4, 5}
+//  fmt.Println(Union[int](a, b))
+//  // output: []int{1, 2, 4, 5, 6}
 //
-// [1, 1, 3, 4, 5, 6] >> [1, 3, 4, 5, 6]
+//  // example #2
+//  fmt.Println(Union[int]([]int{1, 1, 3, 4, 5, 6}))
+//  // output: []int{1, 3, 4, 5, 6}
 func Union[T comparable](arrs ...[]T) []T {
 	m := make(map[T]struct{})
 
@@ -182,9 +188,15 @@ func Union[T comparable](arrs ...[]T) []T {
 
 // Difference returns a slice of values that are only present in one of the input slices
 //
-// [1, 2, 2, 4, 6] & [2, 4, 5] >> [1, 5, 6]
+//  // example #1
+//  a := []int{1, 2, 2, 4, 6}
+//  b := []int{2, 4, 5}
+//  fmt.Println(Difference[int](a, b))
+//  // output: []int{1, 5, 6}
 //
-// [1, 1, 3, 4, 5, 6] >> [1, 3, 4, 5, 6]
+//  // example #2
+//  fmt.Println(Difference[int]([]int{1, 1, 3, 4, 5, 6}))
+//  // output: []int{1, 3, 4, 5, 6}
 func Difference[T comparable](arrs ...[]T) []T {
 	m := make(map[T]int)