Skip to content

Commit 47cb543

Browse files
committed
Fix doc warnings
1 parent efe9f17 commit 47cb543

1 file changed

Lines changed: 14 additions & 14 deletions

File tree

lib/money.ex

Lines changed: 14 additions & 14 deletions
Original file line numberDiff line numberDiff line change
@@ -492,7 +492,7 @@ defmodule Money do
492492
493493
### Options
494494
495-
* `:locale` is any valid locale returned by `Localize.known_locale_names/0`
495+
* `:locale` is any valid locale returned by `Localize.supported_locales/0`
496496
or a `Localize.LanguageTag` struct.
497497
The default is `Localize.get_locale/0`.
498498
@@ -712,8 +712,8 @@ defmodule Money do
712712
* `money` is any valid `t:Money.t/0` type returned
713713
by `Money.new/2`.
714714
715-
* `options` is a keyword list of options or a `t:Localize.Number.Format.Options.t/0`
716-
struct.
715+
* `options` is a keyword list, or a validated options struct accepted by
716+
`Localize.Number.to_string/2`.
717717
718718
### Returns
719719
@@ -767,7 +767,7 @@ defmodule Money do
767767
{:ok, "১০০.০০€"}
768768
769769
"""
770-
@spec to_string(Money.t(), Keyword.t() | Localize.Number.Format.Options.t()) ::
770+
@spec to_string(Money.t(), Keyword.t() | map()) ::
771771
{:ok, String.t()} | {:error, {module, String.t()}} | {:error, Exception.t()}
772772

773773
def to_string(money, options \\ [])
@@ -873,8 +873,8 @@ defmodule Money do
873873
* `money` is any valid `t:Money.t/0` type returned
874874
by `Money.new/2`.
875875
876-
* `options` is a keyword list of options or a
877-
`%Localize.Number.Format.Options{}` struct.
876+
* `options` is a keyword list, or a validated options struct accepted by
877+
`Localize.Number.to_string/2`.
878878
879879
### Options
880880
@@ -895,7 +895,7 @@ defmodule Money do
895895
"1,234 US dollars"
896896
897897
"""
898-
@spec to_string!(Money.t(), Keyword.t() | Localize.Number.Format.Options.t()) ::
898+
@spec to_string!(Money.t(), Keyword.t() | map()) ::
899899
String.t() | no_return()
900900

901901
def to_string!(%Money{} = money, options \\ []) do
@@ -2354,13 +2354,13 @@ defmodule Money do
23542354
23552355
### Arguments
23562356
2357-
* `money` is any `t:Money.t/0` struct returned by `Localize.Currency.new/2`.
2357+
* `money` is any `t:Money.t/0` struct returned by `Money.Currency.new/2`.
23582358
23592359
* `options` is a keyword list of options.
23602360
23612361
### Options
23622362
2363-
* `:locale` is any valid locale returned by `Localize.known_locale_names/0`
2363+
* `:locale` is any valid locale returned by `Localize.supported_locales/0`
23642364
or a `Localize.LanguageTag` struct.
23652365
The default is `Localize.get_locale/0`.
23662366
@@ -2388,7 +2388,7 @@ defmodule Money do
23882388
23892389
### Arguments
23902390
2391-
* `money` is any `t:Money.t/0` struct returned by `Localize.Currency.new/2`.
2391+
* `money` is any `t:Money.t/0` struct returned by `Money.Currency.new/2`.
23922392
23932393
* `to_currency` is a valid currency code into which the `money` is converted.
23942394
@@ -2464,7 +2464,7 @@ defmodule Money do
24642464
24652465
### Arguments
24662466
2467-
* `money` is any `t:Money.t/0` struct returned by `Localize.Currency.new/2`.
2467+
* `money` is any `t:Money.t/0` struct returned by `Money.Currency.new/2`.
24682468
24692469
* `to_currency` is a valid currency code into which the `money` is converted.
24702470
@@ -2508,7 +2508,7 @@ defmodule Money do
25082508
25092509
### Arguments
25102510
2511-
* `from` is any `t:Money.t/0` struct returned by `Localize.Currency.new/2` or a valid
2511+
* `from` is any `t:Money.t/0` struct returned by `Money.Currency.new/2` or a valid
25122512
currency code.
25132513
25142514
* `to_currency` is a valid currency code into which the `money` is converted.
@@ -2557,7 +2557,7 @@ defmodule Money do
25572557
25582558
### Arguments
25592559
2560-
* `from` is any `t:Money.t/0` struct returned by `Localize.Currency.new/2` or a valid
2560+
* `from` is any `t:Money.t/0` struct returned by `Money.Currency.new/2` or a valid
25612561
currency code.
25622562
25632563
* `to_currency` is a valid currency code into which the `money` is converted.
@@ -2654,7 +2654,7 @@ defmodule Money do
26542654
26552655
### Options
26562656
2657-
* `money` is any `t:Money.t/0` struct returned by `Localize.Currency.new/2`.
2657+
* `money` is any `t:Money.t/0` struct returned by `Money.Currency.new/2`.
26582658
26592659
### Notes
26602660

0 commit comments

Comments
 (0)