Skip to content

Commit 3c573f9

Browse files
authored
Clarifying xml doc on ScheduleStatus (#797)
1 parent 87d0c98 commit 3c573f9

File tree

1 file changed

+7
-1
lines changed

1 file changed

+7
-1
lines changed

src/WebJobs.Extensions/Extensions/Timers/Scheduling/ScheduleStatus.cs

Lines changed: 7 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -6,7 +6,8 @@
66
namespace Microsoft.Azure.WebJobs.Extensions.Timers
77
{
88
/// <summary>
9-
/// Represents a timer schedule status.
9+
/// Represents a timer schedule status. The scheduler uses this information to calculate
10+
/// function invocation times.
1011
/// </summary>
1112
public class ScheduleStatus
1213
{
@@ -18,6 +19,11 @@ public class ScheduleStatus
1819
/// <summary>
1920
/// Gets or sets the expected next schedule occurrence.
2021
/// </summary>
22+
/// <remarks>
23+
/// When a function is invoked by the scheduler, the value of this property
24+
/// will effectively be the current time. To determine the next schedule occurrence
25+
/// from the current invocation, <see cref="TimerInfo.Schedule"/> can be used.
26+
/// </remarks>
2127
public DateTime Next { get; set; }
2228

2329
/// <summary>

0 commit comments

Comments
 (0)