Deprecate DatePeriod.plus and DateTimePeriod.plus

Fixes #381
Kotlin · Oct 18, 2024 · 2db494c · 2db494c
1 parent 670a914
commit 2db494c
Showing 1 changed file with 8 additions and 0 deletions.
diff --git a/core/common/src/DateTimePeriod.kt b/core/common/src/DateTimePeriod.kt
@@ -577,6 +577,10 @@ public fun Duration.toDateTimePeriod(): DateTimePeriod = buildDateTimePeriod(tot
  *
  * @throws DateTimeArithmeticException if arithmetic overflow happens.
  */
+@Deprecated(
+    "Adding periods is not a well-defined operation. See https://github.com/Kotlin/kotlinx-datetime/issues/381",
+    level = DeprecationLevel.ERROR
+)
 public operator fun DateTimePeriod.plus(other: DateTimePeriod): DateTimePeriod = buildDateTimePeriod(
     safeAdd(totalMonths, other.totalMonths),
     safeAdd(days, other.days),
@@ -591,6 +595,10 @@ public operator fun DateTimePeriod.plus(other: DateTimePeriod): DateTimePeriod =
  *
  * @throws DateTimeArithmeticException if arithmetic overflow happens.
  */
+@Deprecated(
+    "Adding periods is not a well-defined operation. See https://github.com/Kotlin/kotlinx-datetime/issues/381",
+    level = DeprecationLevel.ERROR
+)
 public operator fun DatePeriod.plus(other: DatePeriod): DatePeriod = DatePeriod(
     safeAdd(totalMonths, other.totalMonths),
     safeAdd(days, other.days),