Skip to content

Commit e91155f

Browse files
committed
Copy editing
1 parent 637290c commit e91155f

File tree

1 file changed

+19
-18
lines changed

1 file changed

+19
-18
lines changed

lib/money.ex

Lines changed: 19 additions & 18 deletions
Original file line numberDiff line numberDiff line change
@@ -429,7 +429,7 @@ defmodule Money do
429429
binary or atom currency code or an
430430
[ISO 24165](https://www.iso.org/standard/80601.html) token identifier or shortname.
431431
432-
* `amount` is a float
432+
* `amount` is a float.
433433
434434
* `options` is a keyword list of options passed
435435
to `Money.new/3`. The default is `[]`.
@@ -460,11 +460,11 @@ defmodule Money do
460460
### Arguments
461461
462462
* `money` is any valid `t:Money.t/0` type returned
463-
by `Money.new/2`
463+
by `Money.new/2`.
464464
465465
* `options` is a keyword list of options. These
466466
options are used when calling `Money.to_string/2`.
467-
The default is `[]`
467+
The default is `[]`.
468468
469469
"""
470470

@@ -722,7 +722,7 @@ defmodule Money do
722722
723723
* `{:ok, string}` or
724724
725-
* `{:error, reason}`
725+
* `{:error, reason}`.
726726
727727
### Options
728728
@@ -833,16 +833,17 @@ defmodule Money do
833833
### Arguments
834834
835835
* `money` is any valid `t:Money.t/0` type returned
836-
by `Money.new/2`
836+
by `Money.new/2`.
837837
838-
* `options` is a keyword list of options or a `%Cldr.Number.Format.Options{}` struct
838+
* `options` is a keyword list of options or a
839+
`%Cldr.Number.Format.Options{}` struct.
839840
840841
### Options
841842
842843
* `:backend` is any CLDR backend module. The default is
843844
`Money.default_backend!/0`.
844845
845-
* Any other options are passed to `Cldr.Number.to_string/3`
846+
* Any other options are passed to `Cldr.Number.to_string/3`.
846847
847848
### Examples
848849
@@ -870,16 +871,16 @@ defmodule Money do
870871
end
871872

872873
@doc """
873-
Returns the amount part of a `Money` type as a `Decimal`
874+
Returns the amount part of a `Money` type as a `Decimal`.
874875
875876
### Arguments
876877
877878
* `money` is any valid `t:Money.t/0` type returned
878-
by `Money.new/2`
879+
by `Money.new/2`.
879880
880881
### Returns
881882
882-
* a `Decimal.t`
883+
* a `Decimal.t`.
883884
884885
## Example
885886
@@ -956,7 +957,7 @@ defmodule Money do
956957
957958
* `{:ok, money}` or
958959
959-
* `{:error, reason}`
960+
* `{:error, reason}`.
960961
961962
## Example
962963
@@ -2229,7 +2230,7 @@ defmodule Money do
22292230
atom or string and the value is a Decimal conversion factor. The default is the
22302231
latest available exchange rates returned from `Money.ExchangeRates.latest_rates/0`.
22312232
2232-
## Converting to a currency defined in a locale
2233+
### Converting to a currency defined in a locale
22332234
22342235
To convert a `Money` to a currency defined by a locale,
22352236
`Cldr.Currency.currency_from_locale/1` can be called with
@@ -2494,7 +2495,7 @@ defmodule Money do
24942495
* Since the returned integer is expected to have the implied fractional
24952496
digits the `Money` needs to be rounded which is what this function does.
24962497
2497-
## Example
2498+
### Example
24982499
24992500
iex> m = Money.new(:USD, "200.012356")
25002501
Money.new(:USD, "200.012356")
@@ -2656,7 +2657,7 @@ defmodule Money do
26562657
* `options` is a keyword list of options passed
26572658
to `Money.new/3`. The default is `[]`.
26582659
2659-
## Example
2660+
### Example
26602661
26612662
iex> Money.zero(:USD)
26622663
Money.new(:USD, "0")
@@ -2692,7 +2693,7 @@ defmodule Money do
26922693
* `money` is any valid `t:Money.t/0` type returned
26932694
by `Money.new/2`
26942695
2695-
## Example
2696+
### Example
26962697
26972698
iex> Money.zero?(Money.new(:USD, 0))
26982699
true
@@ -2724,7 +2725,7 @@ defmodule Money do
27242725
* `money` is any valid `t:Money.t/0` type returned
27252726
by `Money.new/2`
27262727
2727-
## Example
2728+
### Example
27282729
27292730
iex> Money.integer?(Money.new(:USD, 0))
27302731
true
@@ -2763,7 +2764,7 @@ defmodule Money do
27632764
* `money` is any valid `t:Money.t/0` type returned
27642765
by `Money.new/2`
27652766
2766-
## Example
2767+
### Example
27672768
27682769
iex> Money.positive?(Money.new(:USD, 1))
27692770
true
@@ -2794,7 +2795,7 @@ defmodule Money do
27942795
* `money` is any valid `t:Money.t/0` type returned
27952796
by `Money.new/2`
27962797
2797-
## Example
2798+
### Example
27982799
27992800
iex> Money.negative?(Money.new(:USD, -1))
28002801
true

0 commit comments

Comments
 (0)