From a72da82172bde13c5bea095563ad7d6f89348ef9 Mon Sep 17 00:00:00 2001
From: Andy Long <andy@theouteredge.co.uk>
Date: Sat, 3 Sep 2022 19:31:41 +0100
Subject: [PATCH] Documentation comment for OrderBy which I missed out

---
 orderBy.go | 3 +++
 1 file changed, 3 insertions(+)

diff --git a/orderBy.go b/orderBy.go
index b61093d..36435c5 100644
--- a/orderBy.go
+++ b/orderBy.go
@@ -1,5 +1,8 @@
 package underscore
 
+// Orders a slice by a field value within a struct, the predicate allow you
+// to pick the fields you want to orderBy. Use > for ASC or < for DESC
+//   func (left Person, right Person) bool { return person.Age > person.Age }
 func OrderBy[T any](list []T, predicate func(T, T) bool) []T {
 	swaps := true
 	var tmp T