Skip to content

Commit 54658a9

Browse files
authored
Improve documentation (#208)
- **Make it even more clear that its UTC** - **Remove strange artefact 'bool' in documentation** fixes #91
2 parents f5150da + d0dac31 commit 54658a9

File tree

1 file changed

+4
-4
lines changed

1 file changed

+4
-4
lines changed

proto/frequenz/api/dispatch/v1/dispatch.proto

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -203,10 +203,10 @@ message DispatchMetadata {
203203

204204
// Filter parameter for specifying multiple time intervals
205205
message TimeIntervalFilter {
206-
// Filter by time >= this timestamp.
206+
// Filter by time >= this UTC timestamp.
207207
google.protobuf.Timestamp from = 1;
208208

209-
// Filter by time <= this timestamp.
209+
// Filter by time <= this UTC timestamp.
210210
google.protobuf.Timestamp to = 2;
211211
}
212212

@@ -448,7 +448,7 @@ message RecurrenceRule {
448448

449449
// When this dispatch should end.
450450
// A dispatch can either recur a fixed number of times, or until a given timestamp.
451-
// If this field is not set, the dispatch will recur indefinitely.bool
451+
// If this field is not set, the dispatch will recur indefinitely.
452452
EndCriteria end_criteria = 3;
453453

454454
// On which minute(s) of the hour does the event occur
@@ -597,7 +597,7 @@ message UpdateMicrogridDispatchRequest {
597597
repeated uint32 bymonths = 8;
598598
}
599599

600-
// The start time
600+
// The start time in UTC.
601601
// When updating a dispatch, ensure that the starting timestamp is set to
602602
// the current time or any future time.
603603
// Timestamps earlier than the current time are not allowed.

0 commit comments

Comments
 (0)