From fbf58eff4262ed0d1bce7fa548a8f01294f7d1e1 Mon Sep 17 00:00:00 2001
From: Ruidy <ruidy.nemausat@gmail.com>
Date: Thu, 21 Nov 2024 05:23:00 +0100
Subject: [PATCH] Refresh documentation (#39)

* minor documentation fixes

* fix Hugo warnings

* add openssf badge
---
 README.md                                                    | 1 +
 docs/themes/hugo-geekdoc/layouts/partials/language.html      | 2 +-
 .../layouts/partials/microformats/opengraph.html             | 2 +-
 .../layouts/partials/microformats/twitter_cards.html         | 2 +-
 go.mod                                                       | 2 +-
 join.go                                                      | 4 ++--
 orderBy.go                                                   | 5 +++--
 pointers.go                                                  | 2 +-
 range.go                                                     | 2 +-
 slices.go                                                    | 4 ++--
 sum.go                                                       | 4 ++--
 ternary.go                                                   | 2 ++
 tuple.go                                                     | 2 ++
 unique.go                                                    | 1 +
 zip.go                                                       | 2 +-
 15 files changed, 22 insertions(+), 15 deletions(-)

diff --git a/README.md b/README.md
index deecf5e..5962609 100644
--- a/README.md
+++ b/README.md
@@ -4,6 +4,7 @@
 [![Go version](https://img.shields.io/github/go-mod/go-version/rjNemo/underscore?style=for-the-badge&logo=go)](https://pkg.go.dev/github.com/rjNemo/underscore)
 ![Go report](https://goreportcard.com/badge/github.com/rjNemo/underscore?style=for-the-badge)
 ![test coverage](https://img.shields.io/codecov/c/github/rjNemo/underscore?style=for-the-badge&logo=codecov)
+[![OpenSSF Best Practices](https://www.bestpractices.dev/projects/9726/badge?style=for-the-badge)](https://www.bestpractices.dev/projects/9726)
 
 ![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)
 
diff --git a/docs/themes/hugo-geekdoc/layouts/partials/language.html b/docs/themes/hugo-geekdoc/layouts/partials/language.html
index 845b92b..26db239 100644
--- a/docs/themes/hugo-geekdoc/layouts/partials/language.html
+++ b/docs/themes/hugo-geekdoc/layouts/partials/language.html
@@ -1,4 +1,4 @@
-{{ if .Site.IsMultiLingual }}
+{{ if hugo.IsMultilingual }}
   <span class="gdoc-language">
     <ul class="gdoc-language__selector" role="button" aria-pressed="false" tabindex="0">
       <li>
diff --git a/docs/themes/hugo-geekdoc/layouts/partials/microformats/opengraph.html b/docs/themes/hugo-geekdoc/layouts/partials/microformats/opengraph.html
index 97716ca..4c01be2 100644
--- a/docs/themes/hugo-geekdoc/layouts/partials/microformats/opengraph.html
+++ b/docs/themes/hugo-geekdoc/layouts/partials/microformats/opengraph.html
@@ -63,6 +63,6 @@
 {{- end }}
 
 {{- /* Facebook Page Admin ID for Domain Insights */}}
-{{- with .Site.Social.facebook_admin }}
+{{- with .Site.Params.facebook.adminID }}
   <meta property="fb:admins" content="{{ . }}" />
 {{- end }}
diff --git a/docs/themes/hugo-geekdoc/layouts/partials/microformats/twitter_cards.html b/docs/themes/hugo-geekdoc/layouts/partials/microformats/twitter_cards.html
index a2cc08c..da07262 100644
--- a/docs/themes/hugo-geekdoc/layouts/partials/microformats/twitter_cards.html
+++ b/docs/themes/hugo-geekdoc/layouts/partials/microformats/twitter_cards.html
@@ -10,6 +10,6 @@
 {{- with partial "utils/description" . }}
   <meta name="twitter:description" content="{{ . | plainify | htmlUnescape | chomp }}" />
 {{- end }}
-{{- with .Site.Social.twitter -}}
+{{- with .Site.Params.twitter -}}
   <meta name="twitter:site" content="@{{ . }}" />
 {{- end }}
diff --git a/go.mod b/go.mod
index aa40850..8be597e 100644
--- a/go.mod
+++ b/go.mod
@@ -1,6 +1,6 @@
 module github.com/rjNemo/underscore
 
-go 1.23
+go 1.23.3
 
 require (
 	github.com/stretchr/testify v1.8.4
diff --git a/join.go b/join.go
index c681015..fdb3208 100644
--- a/join.go
+++ b/join.go
@@ -1,6 +1,6 @@
 package underscore
 
-// Joins two slices together and returns a Tuple of [T, []P], the selectors allow you to pick the
+// Join joins two slices together and returns a Tuple of [T, []P], the selectors allow you to pick the
 // keys you want to use from your struct's to join the sets together
 func Join[T, P any, S comparable](
 	left []T,
@@ -18,7 +18,7 @@ func Join[T, P any, S comparable](
 	return results
 }
 
-// Joins two slices together and returns a []O where O is defined by the output
+// JoinProject joins two slices together and returns a []O where O is defined by the output
 // of your projection function
 // The selectors allow you to pick the keys from your structure to use as the join keys
 // While the projection functions allows you to reformat joined datasets
diff --git a/orderBy.go b/orderBy.go
index 8ee7671..4f666ee 100644
--- a/orderBy.go
+++ b/orderBy.go
@@ -1,8 +1,9 @@
 package underscore
 
-// Orders a slice by a field value within a struct, the predicate allows you
+// OrderBy orders a slice by a field value within a struct, the predicate allows you
 // to pick the fields you want to orderBy. Use > for ASC or < for DESC
-//   func (left Person, right Person) bool { return left.Age > right.Age }
+//
+//	func (left Person, right Person) bool { return left.Age > right.Age }
 func OrderBy[T any](list []T, predicate func(T, T) bool) []T {
 	swaps := true
 	var tmp T
diff --git a/pointers.go b/pointers.go
index dc5c7e2..494f831 100644
--- a/pointers.go
+++ b/pointers.go
@@ -1,6 +1,6 @@
 package underscore
 
-// Convert values to pointers
+// ToPointer Convert values to pointers
 //
 // Instead of:
 // v := "value"
diff --git a/range.go b/range.go
index 204c6b8..5a67175 100644
--- a/range.go
+++ b/range.go
@@ -1,6 +1,6 @@
 package underscore
 
-// Creates a sequence of numbers, i.e. u.Range(0, 3) = [0 1 2 3], while u.Range(3, 0) = [3 2 1 0]
+// Range creates a sequence of numbers, i.e. u.Range(0, 3) = [0 1 2 3], while u.Range(3, 0) = [3 2 1 0]
 func Range(start int, end int) (result []int) {
 	if start < end {
 		for i := start; i <= end; i++ {
diff --git a/slices.go b/slices.go
index 0101cf6..ad2f462 100644
--- a/slices.go
+++ b/slices.go
@@ -6,14 +6,14 @@ import (
 	"golang.org/x/exp/constraints"
 )
 
-// sort any slice ASENDING
+// SortSliceASC sorts any slice ASCENDING
 func SortSliceASC[T constraints.Ordered](s []T) {
 	sort.SliceStable(s, func(i, j int) bool {
 		return s[i] < s[j]
 	})
 }
 
-// sort any slice DESCENDING
+// SortSliceDESC sorts any slice DESCENDING
 func SortSliceDESC[T constraints.Ordered](s []T) {
 	sort.SliceStable(s, func(i, j int) bool {
 		return s[i] > s[j]
diff --git a/sum.go b/sum.go
index 0cc9652..bd18a35 100644
--- a/sum.go
+++ b/sum.go
@@ -10,8 +10,8 @@ func Sum[T constraints.Ordered](values []T) (sum T) {
 	return sum
 }
 
-// Sums the values you select from your struct, basically a sort cut instead of
-// having to perform a u.Map followed by a u.Sum
+// SumMap sums the values you select from your struct, basically a sort cut instead of
+// having to perform a [Map] followed by a [Sum].
 func SumMap[T any, R constraints.Ordered](list []T, selector func(T) R) (sum R) {
 	for _, v := range list {
 		sum += selector(v)
diff --git a/ternary.go b/ternary.go
index 01d256d..ebe8df2 100644
--- a/ternary.go
+++ b/ternary.go
@@ -1,5 +1,7 @@
 package underscore
 
+// Ternary returns the first argument if the condition is true, otherwise the second argument.
+// Ternary is a special form of the if statement. It allows you to write code that is more concise and less verbose.
 func Ternary[T any](condition bool, pos, neg T) T {
 	if condition {
 		return pos
diff --git a/tuple.go b/tuple.go
index a229f52..1ab7b5f 100644
--- a/tuple.go
+++ b/tuple.go
@@ -1,5 +1,7 @@
 package underscore
 
+// Tuple is a generic tuple type.
+// It is used to return multiple values from a function.
 type Tuple[L, R any] struct {
 	Left  L
 	Right R
diff --git a/unique.go b/unique.go
index 718ddc8..111e332 100644
--- a/unique.go
+++ b/unique.go
@@ -1,5 +1,6 @@
 package underscore
 
+// Unique returns a slice of unique values from the given slice.
 func Unique[T comparable](values []T) (uniques []T) {
 	seen := make(map[T]bool, 0)
 	for _, v := range values {
diff --git a/zip.go b/zip.go
index ca53e62..07e2d8c 100644
--- a/zip.go
+++ b/zip.go
@@ -1,6 +1,6 @@
 package underscore
 
-// Zips two slices togther so all the elements of left slice are attached to the corresponding
+// Zip joins two slices together so all the elements of left slice are attached to the corresponding
 // elements of the right slice, i.e. [one two three] [1 2 3 4] = [{one, 1} {two, 2} {three, 3}]
 // the returned data will be the size of the smallest slice
 func Zip[L any, R any](left []L, right []R) []Tuple[L, R] {