From b3953ef42ac7160d52e46d75d4da47e6498fa70d Mon Sep 17 00:00:00 2001
From: Martin Angers <martin.n.angers@gmail.com>
Date: Mon, 14 Jun 2021 09:06:47 -0400
Subject: [PATCH] Finalize documentation

---
 type.go      | 29 +++++++++++++++++++----------
 type_test.go |  7 +++++++
 2 files changed, 26 insertions(+), 10 deletions(-)

diff --git a/type.go b/type.go
index 943756b..6646c14 100644
--- a/type.go
+++ b/type.go
@@ -124,17 +124,26 @@ type Matcher interface {
 // Single compiles a selector string to a Matcher that stops after the first
 // match is found.
 //
-// By default, Selection.Find and other functions that accept a selector
-// string to find nodes will use all matches corresponding to that selector.
-// By using the Matcher returned by Single, at most the first match will be
-// used.
+// By default, Selection.Find and other functions that accept a selector string
+// to select nodes will use all matches corresponding to that selector. By
+// using the Matcher returned by Single, at most the first match will be
+// selected.
 //
-// Note that the single-selection property of the Matcher only applies for
-// methods where the Matcher is used to select nodes, not to filter or check
-// if a node matches the Matcher - in those cases, the behaviour of the
-// Matcher is unchanged (e.g. FilterMatcher(Single("div")) will still result
-// in a Selection with multiple "div"s if there were many "div"s in the
-// Selection to begin with).
+// For example, those two statements are semantically equivalent:
+//
+//     sel1 := doc.Find("a").First()
+//     sel2 := doc.FindMatcher(goquery.Single("a"))
+//
+// The one using Single is optimized to be potentially much faster on large
+// documents.
+//
+// Only the behaviour of the MatchAll method of the Matcher interface is
+// altered compared to standard Matchers. This means that the single-selection
+// property of the Matcher only applies for Selection methods where the Matcher
+// is used to select nodes, not to filter or check if a node matches the
+// Matcher - in those cases, the behaviour of the Matcher is unchanged (e.g.
+// FilterMatcher(Single("div")) will still result in a Selection with multiple
+// "div"s if there were many "div"s in the Selection to begin with).
 func Single(selector string) Matcher {
 	return singleMatcher{compileMatcher(selector)}
 }
diff --git a/type_test.go b/type_test.go
index 0bb2a4f..84080a9 100644
--- a/type_test.go
+++ b/type_test.go
@@ -231,6 +231,13 @@ func TestSingle(t *testing.T) {
 		t.Fatalf("want %q, got %q", "1", text)
 	}
 
+	// Verify semantic equivalence
+	sel1 := doc.Find("div").First()
+	sel2 := doc.FindMatcher(Single("div"))
+	if sel1.Text() != sel2.Text() {
+		t.Fatalf("want sel1 to equal sel2")
+	}
+
 	// Here, the Single has no effect as the selector is used to filter
 	// from the existing selection, not to find nodes in the document.
 	divs := doc.Find("div")