@@ -1294,7 +1294,7 @@ defmodule Money do
1294
1294
1295
1295
* `{:ok, maximum_money}` or
1296
1296
1297
- * `{:error, reason}`
1297
+ * `{:error, reason}`.
1298
1298
1299
1299
## Example
1300
1300
@@ -1414,22 +1414,21 @@ defmodule Money do
1414
1414
1415
1415
@ doc """
1416
1416
Clamps a `t:Money.t/0` to be in the range of `minimum`
1417
- and `maximum`.
1417
+ to `maximum`.
1418
1418
1419
1419
### Arguments
1420
1420
1421
1421
* `money`, `minimum` and `maximum` are any valid `t:Money.t/0` types returned
1422
- by `Money.new/2`. `They should be of the same
1423
- currency.
1422
+ by `Money.new/2`. They should be of the same currency.
1424
1423
1425
1424
### Returns
1426
1425
1427
- * `{:ok, money]` where `money` is clamped to the minimum or maximum if required.
1426
+ * `{:ok, money]` where `money` is clamped to the ` minimum` or ` maximum` if required.
1428
1427
* If `money` is within the range `minimum..maximum` then `money` is returned unchanged.
1429
- * If it is less than `minimum` then `minimum` is returned.
1430
- * If it is greater than `maximum` then `maximum` is returned.
1428
+ * If `money` is less than `minimum` then `minimum` is returned.
1429
+ * If `money` is greater than `maximum` then `maximum` is returned.
1431
1430
1432
- * or `{:error, {module, reason} }`.
1431
+ * or `{:error, reason}`.
1433
1432
1434
1433
### Examples
1435
1434
@@ -1476,22 +1475,21 @@ defmodule Money do
1476
1475
1477
1476
@ doc """
1478
1477
Clamps a `t:Money.t/0` to be in the range of `minimum`
1479
- and `maximum` or raises an exception.
1478
+ to `maximum` or raises an exception.
1480
1479
1481
1480
### Arguments
1482
1481
1483
1482
* `money`, `minimum` and `maximum` are any valid `t:Money.t/0` types returned
1484
- by `Money.new/2`. `They should be of the same
1485
- currency.
1483
+ by `Money.new/2`. They should be of the same currency.
1486
1484
1487
1485
### Returns
1488
1486
1489
- * `{:ok, money] ` where `money` is clamped to the minimum or maximum if required.
1487
+ * `money` where `money` is clamped to the ` minimum` or ` maximum` if required.
1490
1488
* If `money` is within the range `minimum..maximum` then `money` is returned unchanged.
1491
- * If it is less than `minimum` then `minimum` is returned.
1492
- * If it is greater than `maximum` then `maximum` is returned.
1489
+ * If `money` is less than `minimum` then `minimum` is returned.
1490
+ * If `money` is greater than `maximum` then `maximum` is returned.
1493
1491
1494
- * or `{:error, {module, reason} }`.
1492
+ * or `{:error, reason}`.
1495
1493
1496
1494
### Examples
1497
1495
@@ -1541,12 +1539,11 @@ defmodule Money do
1541
1539
### Arguments
1542
1540
1543
1541
* `money`, `minimum` and `maximum` are any valid `t:Money.t/0` types returned
1544
- by `Money.new/2`. `They should be of the same
1545
- currency.
1542
+ by `Money.new/2`. They should be of the same currency.
1546
1543
1547
1544
### Returns
1548
1545
1549
- * `true` or `false`
1546
+ * `true` or `false`.
1550
1547
1551
1548
### Examples
1552
1549
0 commit comments