Skip to content

Commit 8922365

Browse files
committed
move the note about xmax > xmin requirement to the arguments spec
1 parent 7ba9853 commit 8922365

File tree

1 file changed

+1
-3
lines changed

1 file changed

+1
-3
lines changed

doc/specs/stdlib_math.md

Lines changed: 1 addition & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -22,8 +22,6 @@ title: math
2222
Limits the input value `x` to the given interval [`xmin`, `xmax`] (interval is `xmin` and `xmax` inclusive). Returns a value which lies in the given interval and is closest to the input value `x`.
2323
If the input value `x` already lies in the given interval, then the output value will be equal to the input value.
2424

25-
Note: A valid input must **NOT** have `xmin` value greater than `xmax` value.
26-
2725
#### Syntax
2826

2927
`res = [[stdlib_math(module):clip(interface)]] (x, xmin, xmax)`
@@ -40,7 +38,7 @@ Elemental function.
4038

4139
`x`: scalar of either `integer` or `real`. This argument is `intent(in)`.
4240
`xmin`: scalar of either `integer` or `real`. This argument is `intent(in)`.
43-
`xmax`: scalar of either `integer` or `real`. This argument is `intent(in)`.
41+
`xmax`: scalar of either `integer` or `real`, which must be greater than or equal to `xmin`. This argument is `intent(in)`.
4442

4543
Note: All arguments must have same `type` and same `kind`.
4644

0 commit comments

Comments
 (0)