From c6a9d3acf01475177a3a3d3c9f6f37390811e62e Mon Sep 17 00:00:00 2001
From: "Ruben W." <rubenwe@users.noreply.github.com>
Date: Mon, 30 Sep 2024 19:45:03 +0200
Subject: [PATCH] Update documentation in IReminderTable (#9132)

* Update documentation in IReminderTable

Specifically, mentioning the case that begin >= end may occur when timers are read.

* Rephrase to remove warnings about XML
---
 .../SystemTargetInterfaces/IReminderTable.cs                 | 5 +++--
 1 file changed, 3 insertions(+), 2 deletions(-)

diff --git a/src/Orleans.Reminders/SystemTargetInterfaces/IReminderTable.cs b/src/Orleans.Reminders/SystemTargetInterfaces/IReminderTable.cs
index 5179ae3ba1..d9a1ec28f7 100644
--- a/src/Orleans.Reminders/SystemTargetInterfaces/IReminderTable.cs
+++ b/src/Orleans.Reminders/SystemTargetInterfaces/IReminderTable.cs
@@ -38,7 +38,8 @@ Task StartAsync(CancellationToken cancellationToken = default)
         Task<ReminderTableData> ReadRows(GrainId grainId);
 
         /// <summary>
-        /// Return all rows that have their <see cref="GrainId.GetUniformHashCode"/> in the range (start, end]
+        /// Returns all rows that have their <see cref="GrainId.GetUniformHashCode"/> in the range (begin, end].
+        /// If begin is greater or equal to end, returns all entries with hash greater begin or hash less or equal to end.
         /// </summary>
         /// <param name="begin">The exclusive lower bound.</param>
         /// <param name="end">The inclusive upper bound.</param>
@@ -46,7 +47,7 @@ Task StartAsync(CancellationToken cancellationToken = default)
         Task<ReminderTableData> ReadRows(uint begin, uint end);
 
         /// <summary>
-        /// Reads a specifie entry.
+        /// Reads the specified entry.
         /// </summary>
         /// <param name="grainId">The grain ID.</param>
         /// <param name="reminderName">Name of the reminder.</param>