@@ -22,8 +22,8 @@ import kotlinx.serialization.Serializable
22
22
* The time components are: [hours] ([DateTimeUnit.HOUR]), [minutes] ([DateTimeUnit.MINUTE]),
23
23
* [seconds] ([DateTimeUnit.SECOND]), [nanoseconds] ([DateTimeUnit.NANOSECOND]).
24
24
*
25
- * The time components are not independent and always overflow into one another .
26
- * Likewise, months overflow into years.
25
+ * The time components are not independent and are always normalized together .
26
+ * Likewise, months are normalized together with years.
27
27
* For example, there is no difference between `DateTimePeriod(months = 24, hours = 2, minutes = 63)` and
28
28
* `DateTimePeriod(years = 2, hours = 3, minutes = 3)`.
29
29
*
@@ -73,10 +73,10 @@ public sealed class DateTimePeriod {
73
73
internal abstract val totalMonths: Int
74
74
75
75
/* *
76
- * The number of calendar days.
76
+ * The number of calendar days. Can be negative.
77
77
*
78
78
* Note that a calendar day is not identical to 24 hours, see [DateTimeUnit.DayBased] for details.
79
- * Also, this field does not overflow into months, so values larger than 31 can be present.
79
+ * Also, this field does not get normalized together with months, so values larger than 31 can be present.
80
80
*
81
81
* @sample kotlinx.datetime.test.samples.DateTimePeriodSamples.valueNormalization
82
82
*/
@@ -100,7 +100,7 @@ public sealed class DateTimePeriod {
100
100
/* *
101
101
* The number of whole hours in this period. Can be negative.
102
102
*
103
- * This field does not overflow into days, so values larger than 23 or smaller than -23 can be present.
103
+ * This field does not get normalized together with days, so values larger than 23 or smaller than -23 can be present.
104
104
*
105
105
* @sample kotlinx.datetime.test.samples.DateTimePeriodSamples.valueNormalization
106
106
*/
@@ -210,7 +210,6 @@ public sealed class DateTimePeriod {
210
210
* - Optionally, the number of years, followed by `Y`.
211
211
* - Optionally, the number of months, followed by `M`.
212
212
* - Optionally, the number of weeks, followed by `W`.
213
- * This is not a part of the ISO 8601 format but an extension.
214
213
* - Optionally, the number of days, followed by `D`.
215
214
* - The string can end here if there are no more time components.
216
215
* If there are time components, the letter `T` is required.
0 commit comments