Skip to content

Commit

Permalink
Update documentation in IReminderTable (#9132)
Browse files Browse the repository at this point in the history
* Update documentation in IReminderTable

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

* Rephrase to remove warnings about XML
  • Loading branch information
rubenwe authored Sep 30, 2024
1 parent ad8d22d commit c6a9d3a
Showing 1 changed file with 3 additions and 2 deletions.
Original file line number Diff line number Diff line change
Expand Up @@ -38,15 +38,16 @@ 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>
/// <returns>The reminder table entries which fall within the specified range.</returns>
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>
Expand Down

0 comments on commit c6a9d3a

Please sign in to comment.