Skip to content

Commit 2a74b19

Browse files
committed
Fix doc formatting
1 parent a2c0df2 commit 2a74b19

File tree

1 file changed

+15
-18
lines changed

1 file changed

+15
-18
lines changed

lib/money.ex

Lines changed: 15 additions & 18 deletions
Original file line numberDiff line numberDiff line change
@@ -1294,7 +1294,7 @@ defmodule Money do
12941294
12951295
* `{:ok, maximum_money}` or
12961296
1297-
* `{:error, reason}`
1297+
* `{:error, reason}`.
12981298
12991299
## Example
13001300
@@ -1414,22 +1414,21 @@ defmodule Money do
14141414

14151415
@doc """
14161416
Clamps a `t:Money.t/0` to be in the range of `minimum`
1417-
and `maximum`.
1417+
to `maximum`.
14181418
14191419
### Arguments
14201420
14211421
* `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.
14241423
14251424
### Returns
14261425
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.
14281427
* 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.
14311430
1432-
* or `{:error, {module, reason}}`.
1431+
* or `{:error, reason}`.
14331432
14341433
### Examples
14351434
@@ -1476,22 +1475,21 @@ defmodule Money do
14761475

14771476
@doc """
14781477
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.
14801479
14811480
### Arguments
14821481
14831482
* `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.
14861484
14871485
### Returns
14881486
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.
14901488
* 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.
14931491
1494-
* or `{:error, {module, reason}}`.
1492+
* or `{:error, reason}`.
14951493
14961494
### Examples
14971495
@@ -1541,12 +1539,11 @@ defmodule Money do
15411539
### Arguments
15421540
15431541
* `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.
15461543
15471544
### Returns
15481545
1549-
* `true` or `false`
1546+
* `true` or `false`.
15501547
15511548
### Examples
15521549

0 commit comments

Comments
 (0)