Clarify docs for downTo and until

2018-04-20 03:43:55 +03:00
parent 501d969a38
commit c5aed06110
2 changed files with 72 additions and 18 deletions
@@ -73,7 +73,8 @@ object RangeOps : TemplateGroupBase() {
            """
            Returns a progression from this value down to the specified [to] value with the step -1.

-            The [to] value has to be less than this value.
+            The [to] value should be less than or equal to `this` value.
+            If the [to] value is greater than `this` value the returned progression is empty.
            """
        }

@@ -111,6 +112,8 @@ object RangeOps : TemplateGroupBase() {
            """
            Returns a range from this value up to but excluding the specified [to] value.

+            If the [to] value is less than or equal to `this` value the returned range is empty.
+
            ${textWhen(elementType == toType) {
                "If the [to] value is less than or equal to $minValueRef the returned range is empty."
            }}