tree-wide: Ensure that all existing method doc comments follow the expected format

1 files changed, 5 insertions, 3 deletions

diff --git a/lib/slices/sliceutil.go b/lib/slices/sliceutil.go
index 9fe5be4..b8823d3 100644
--- a/lib/slices/sliceutil.go
+++ b/lib/slices/sliceutil.go
@@ -95,7 +95,7 @@ func max(a, b int) int {
 	return b
 }
 
-// Search the slice for a value for which `fn(slice[i]) = 0`.
+// Search searches the slice for a value for which `fn(slice[i]) = 0`.
 //
 //	: + + + 0 0 0 - - -
 //	:       ^ ^ ^
@@ -123,7 +123,8 @@ func Search[T any](slice []T, fn func(T) int) (int, bool) {
 	return 0, false
 }
 
-// Search the slice for the left-most value for which `fn(slice[i]) = 0`.
+// SearchLowest searches the slice for the left-most value for which
+// `fn(slice[i]) = 0`.
 //
 //	: + + + 0 0 0 - - -
 //	:       ^
@@ -153,7 +154,8 @@ func SearchLowest[T any](slice []T, fn func(T) int) (int, bool) {
 	return firstGood, true
 }
 
-// Search the slice for the right-most value for which `fn(slice[i]) = 0`.
+// SearchHighest searches the slice for the right-most value for which
+// `fn(slice[i]) = 0`.
 //
 //	: + + + 0 0 0 - - -
 //	:           ^