From 63ce6878c5d0fe82f9a2e93f72d5dc2e8b8f57b7 Mon Sep 17 00:00:00 2001
From: Dominic Charley-Roy <dcr@stripe.com>
Date: Thu, 3 Jun 2021 11:09:54 -0400
Subject: [PATCH] Update SearchResult documentation.

---
 lib/SearchResult.php | 9 ++++++++-
 1 file changed, 8 insertions(+), 1 deletion(-)

diff --git a/lib/SearchResult.php b/lib/SearchResult.php
index ec54e53f3..97c421d66 100644
--- a/lib/SearchResult.php
+++ b/lib/SearchResult.php
@@ -3,7 +3,14 @@
 namespace Stripe;
 
 /**
- * Class search results.
+ * Search results for an API resource.
+ *
+ * This behaves similarly to <code>Collection</code> in that they both wrap
+ * around a list of objects and provide pagination. However the
+ * <code>SearchResult</code> object paginates by relying on a
+ * <code>next_page</code> token included in the response rather than using
+ * object IDs and a <code>starting_before</code>/<code>ending_after</code>
+ * parameter. Thus, <code>SearchResult</code> only supports forwards pagination.
  *
  * @property string $object
  * @property string $url