Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Update documentation in IReminderTable #9132

Merged
merged 2 commits into from
Sep 30, 2024
Merged

Update documentation in IReminderTable #9132

Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
e39fb00
Update documentation in IReminderTable
rubenwe Sep 2, 2024
7880970
Rephrase to remove warnings about XML
rubenwe Sep 2, 2024
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
5 changes: 3 additions & 2 deletions src/Orleans.Reminders/SystemTargetInterfaces/IReminderTable.cs
View file
Open in desktop
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
Loading