From dabc26ee605e1bd855fbc39b3e8626bb6e45742b Mon Sep 17 00:00:00 2001 From: James Rodewig Date: Mon, 18 Nov 2024 14:57:08 -0500 Subject: [PATCH] [DOCS-3753] Event Feeds: Document `page_size` limit --- Fauna/Core/FeedOptions.cs | 9 ++++++--- 1 file changed, 6 insertions(+), 3 deletions(-) diff --git a/Fauna/Core/FeedOptions.cs b/Fauna/Core/FeedOptions.cs index d9042e7c..f4a72aa7 100644 --- a/Fauna/Core/FeedOptions.cs +++ b/Fauna/Core/FeedOptions.cs @@ -11,7 +11,8 @@ public class FeedOptions : EventOptions /// Initializes a new instance of the class with the specified cursor and optional page size. /// /// The cursor for the feed. Used to resume the Feed. - /// Optional page size for the feed. + /// Optional page size for the feed. Sets the maximum number of events returned per page. Must + /// be in the range 1 to 16000 (inclusive). Defaults to 16. /// public FeedOptions(string cursor, int? pageSize = null) { @@ -23,7 +24,8 @@ public FeedOptions(string cursor, int? pageSize = null) /// Initializes a new instance of the class with the specified start timestamp and optional page size. /// /// The start timestamp for the feed. Used to resume the Feed. - /// Optional page size for the feed. + /// Optional page size for the feed. Sets the maximum number of events returned per page. Must + /// be in the range 1 to 16000 (inclusive). Defaults to 16. /// public FeedOptions(long startTs, int? pageSize = null) { @@ -34,7 +36,8 @@ public FeedOptions(long startTs, int? pageSize = null) /// /// Initializes a new instance of the class with the specified page size. /// - /// The page size for the feed. + /// Maximum number of events returned per page. Must + /// be in the range 1 to 16000 (inclusive). Defaults to 16. public FeedOptions(int pageSize) { PageSize = pageSize;