Skip to content

Commit 6db0a37

Browse files
committed
doc impr
1 parent 1601d42 commit 6db0a37

File tree

1 file changed

+3
-3
lines changed

1 file changed

+3
-3
lines changed

roboquant/src/main/kotlin/org/roboquant/common/Timeframe.kt

+3-3
Original file line numberDiff line numberDiff line change
@@ -377,7 +377,7 @@ data class Timeframe(val start: Instant, val end: Instant, val inclusive: Boolea
377377

378378
/**
379379
* Subtract a [period] from start- and end-time of this timeframe and return the result.
380-
* If the period contains timezone dependent values, UTC will be used as the ZoneId.
380+
* If the period contains timezone-dependent values, UTC will be used as the ZoneId.
381381
* ```
382382
* val newTimeFrame = timeframe - 2.days
383383
* ```
@@ -390,7 +390,7 @@ data class Timeframe(val start: Instant, val end: Instant, val inclusive: Boolea
390390

391391
/**
392392
* Add a [period] to start- and end-time of this timeframe and return the result.
393-
* If the period contains timezone dependent values, UTC will be used as the ZoneId.
393+
* If the period contains timezone-dependent values, UTC will be used as the ZoneId.
394394
* ```
395395
* val newTimeFrame = timeframe + 2.days
396396
* ```
@@ -405,7 +405,7 @@ data class Timeframe(val start: Instant, val end: Instant, val inclusive: Boolea
405405
* Extend this period with a [before] and [after] period and return the result.
406406
* If no [after] period is provided, the same value as for [before] will be used.
407407
*
408-
* If [before] or [after] contain timezone dependent values, UTC will be used as the ZoneId.
408+
* If [before] or [after] contain timezone-dependent values, UTC will be used as the ZoneId.
409409
*/
410410
fun extend(before: TimeSpan, after: TimeSpan = before): Timeframe {
411411
val e = makeValid(end + after)

0 commit comments

Comments
 (0)