Skip to content

Commit f96275c

Browse files
kipcole9kipcole9
committed
Edit docs
1 parent f936bcf commit f96275c

File tree

6 files changed

+62
-62
lines changed

6 files changed

+62
-62
lines changed

‎lib/cldr/backend.ex‎

Lines changed: 23 additions & 26 deletions
Original file line numberDiff line numberDiff line change
@@ -11,6 +11,9 @@ defmodule Cldr.LocaleDisplay.Backend do
1111

1212
quote location: :keep, bind_quoted: [module: module, backend: backend, config: config] do
1313
defmodule LocaleDisplay do
14+
alias Cldr.Locale
15+
alias Cldr.LocaleDisplay
16+
1417
unless Cldr.Config.include_module_docs?(config.generate_docs) do
1518
@moduledoc false
1619
end
@@ -33,14 +36,14 @@ defmodule Cldr.LocaleDisplay.Backend do
3336
and using the [CLDR locale display name algorithm](https://unicode-org.github.io/cldr/ldml/tr35-general.html#locale_display_name_algorithm)
3437
produces a string suitable for presentation.
3538
36-
## Arguments
39+
### Arguments
3740
3841
* `language_tag` is any `t:Cldr.LanguageTag` or
3942
a binary locale name.
4043
4144
* `options` is a keyword list of options.
4245
43-
## Options
46+
### Options
4447
4548
* `:language_display` determines if a language
4649
is displayed in `:standard` format (the default)
@@ -50,20 +53,20 @@ defmodule Cldr.LocaleDisplay.Backend do
5053
a subtag when there are alternatives.
5154
The default is `:default`. Few subtags
5255
provide alternative renderings. Some of
53-
the alternative preferences are`:short`,
56+
the alternative preferences are `:short`,
5457
`:long`, `:menu` and `:variant`.
5558
5659
* `:locale` is a `t:Cldr.LanguageTag` or any valid
5760
locale name returned by `Cldr.known_locale_names/1`.
5861
59-
## Returns
62+
### Returns
6063
6164
* `{:ok, string}` representing a name
6265
suitable for presentation purposes or
6366
6467
* `{:error, {exception, reason}}`
6568
66-
## Examples
69+
### Examples
6770
6871
iex> #{inspect(__MODULE__)}.display_name "en"
6972
{:ok, "English"}
@@ -89,11 +92,8 @@ defmodule Cldr.LocaleDisplay.Backend do
8992
"""
9093
@doc since: "1.1.0"
9194

92-
@spec display_name(
93-
Cldr.Locale.locale_name() | Cldr.LanguageTag.t(),
94-
Cldr.LocaleDisplay.display_options()
95-
) ::
96-
{:ok, String.t()} | {:error, {module(), String.t()}}
95+
@spec display_name(Locale.locale_reference(), LocaleDisplay.display_options()) ::
96+
{:ok, String.t()} | {:error, {module(), String.t()}}
9797

9898
def display_name(language_tag, options \\ []) do
9999
options = Keyword.put(options, :backend, unquote(backend))
@@ -111,14 +111,14 @@ defmodule Cldr.LocaleDisplay.Backend do
111111
and using the [CLDR locale display name algorithm](https://unicode-org.github.io/cldr/ldml/tr35-general.html#locale_display_name_algorithm)
112112
produces a string suitable for presentation.
113113
114-
## Arguments
114+
### Arguments
115115
116116
* `language_tag` is any `t:Cldr.LanguageTag` or
117117
a binary locale name.
118118
119119
* `options` is a keyword list of options.
120120
121-
## Options
121+
### Options
122122
123123
* `:language_display` determines if a language
124124
is displayed in `:standard` format (the default)
@@ -137,14 +137,14 @@ defmodule Cldr.LocaleDisplay.Backend do
137137
* `:backend` is any module that includes `use Cldr` and therefore
138138
is a `Cldr` backend module. The default is `Cldr.default_backend!/0`.
139139
140-
## Returns
140+
### Returns
141141
142142
* a string representation of the language tag
143143
suitable for presentation purposes or
144144
145145
* raises an exception.
146146
147-
## Examples
147+
### Examples
148148
149149
iex> #{inspect(__MODULE__)}.display_name! "en"
150150
"English"
@@ -164,10 +164,7 @@ defmodule Cldr.LocaleDisplay.Backend do
164164
"""
165165
@doc since: "1.1.0"
166166

167-
@spec display_name!(
168-
Cldr.Locale.locale_name() | Cldr.LanguageTag.t(),
169-
Cldr.LocaleDisplay.display_options()
170-
) ::
167+
@spec display_name!(Locale.locale_reference(), LocaleDisplay.display_options()) ::
171168
String.t() | no_return()
172169

173170
def display_name!(language_tag, options \\ []) do
@@ -179,25 +176,25 @@ defmodule Cldr.LocaleDisplay.Backend do
179176
Returns the localised display names data
180177
for a locale name.
181178
182-
## Arguments
179+
### Arguments
183180
184181
* `locale` is any language tag returned by
185182
`#{inspect(__MODULE__)}.new/1`
186183
or a locale name in the list returned by
187184
`#{inspect(config.backend)}.known_locale_names/0`
188185
189-
## Returns
186+
### Returns
190187
191188
* A map of locale display names
192189
193-
## Examples
190+
### Examples
194191
195192
=> #{inspect(__MODULE__)}.display_names("en")
196193
197194
"""
198195
@doc since: "1.0.0"
199196

200-
@spec display_names(Cldr.LanguageTag.t() | Cldr.Locale.locale_name()) ::
197+
@spec display_names(Locale.locale_reference()) ::
201198
{:ok, map()} | {:error, {module(), String.t()}}
202199

203200
def display_names(locale)
@@ -206,25 +203,25 @@ defmodule Cldr.LocaleDisplay.Backend do
206203
Returns the localised time zone names data
207204
for a locale name.
208205
209-
## Arguments
206+
### Arguments
210207
211208
* `locale` is any language tag returned by
212209
`#{inspect(__MODULE__)}.new/1`
213210
or a locale name in the list returned by
214211
`#{inspect(config.backend)}.known_locale_names/0`
215212
216-
## Returns
213+
### Returns
217214
218215
* A map of locale time zone names
219216
220-
## Examples
217+
### Examples
221218
222219
=> #{inspect(__MODULE__)}.time_zone_names("en")
223220
224221
"""
225222
@doc since: "1.0.0"
226223

227-
@spec time_zone_names(Cldr.LanguageTag.t() | Cldr.Locale.locale_name()) ::
224+
@spec time_zone_names(Locale.locale_reference()) ::
228225
{:ok, map()} | {:error, {module(), String.t()}}
229226

230227
def time_zone_names(locale)

‎lib/cldr/locale_display.ex‎

Lines changed: 35 additions & 22 deletions
Original file line numberDiff line numberDiff line change
@@ -13,6 +13,7 @@ defmodule Cldr.LocaleDisplay do
1313
import Cldr.LanguageTag, only: [empty?: 1]
1414

1515
alias Cldr.LanguageTag
16+
alias Cldr.Locale
1617

1718
@basic_tag_order [:language, :script, :territory, :language_variants]
1819
@extension_order [:transform, :locale, :extensions]
@@ -36,14 +37,14 @@ defmodule Cldr.LocaleDisplay do
3637
and using the [CLDR locale display name algorithm](https://unicode-org.github.io/cldr/ldml/tr35-general.html#locale_display_name_algorithm)
3738
produces a string suitable for presentation.
3839
39-
## Arguments
40+
### Arguments
4041
4142
* `language_tag` is any `t:Cldr.LanguageTag` or
4243
a locale name as an atom or string.
4344
4445
* `options` is a keyword list of options.
4546
46-
## Options
47+
### Options
4748
4849
* `:language_display` determines if a language
4950
is displayed in `:standard` format (the default)
@@ -62,38 +63,44 @@ defmodule Cldr.LocaleDisplay do
6263
* `:backend` is any module that includes `use Cldr` and therefore
6364
is a `Cldr` backend module. The default is `Cldr.default_backend!/0`.
6465
65-
## Returns
66+
### Returns
6667
6768
* `{:ok, string}` representing a name
6869
suitable for presentation purposes or
6970
7071
* `{:error, {exception, reason}}`
7172
72-
## Examples
73+
### Notes
7374
74-
iex> Cldr.LocaleDisplay.display_name "en"
75+
* The difference between `language_display: :standard` and
76+
`:dialect` is related to how compound languages are displayed.
77+
See the examples for "nl-BE" below.
78+
79+
### Examples
80+
81+
iex> Cldr.LocaleDisplay.display_name("en")
7582
{:ok, "English"}
7683
77-
iex> Cldr.LocaleDisplay.display_name "en-US", language_display: :standard
84+
iex> Cldr.LocaleDisplay.display_name("en-US", language_display: :standard)
7885
{:ok, "English (United States)"}
7986
80-
iex> Cldr.LocaleDisplay.display_name "en-US", language_display: :dialect
87+
iex> Cldr.LocaleDisplay.display_name("en-US", language_display: :dialect)
8188
{:ok, "American English"}
8289
83-
iex> Cldr.LocaleDisplay.display_name "en-US-u-ca-gregory-cu-aud", language_display: :dialect
90+
iex> Cldr.LocaleDisplay.display_name("en-US-u-ca-gregory-cu-aud", language_display: :dialect)
8491
{:ok, "American English (Gregorian Calendar, Currency: A$)"}
8592
86-
iex> Cldr.LocaleDisplay.display_name "en-US-u-ca-gregory-cu-aud", locale: "fr", language_display: :dialect
93+
iex> Cldr.LocaleDisplay.display_name("en-US-u-ca-gregory-cu-aud", locale: "fr", language_display: :dialect)
8794
{:ok, "anglais américain (calendrier grégorien, devise : A$)"}
8895
89-
iex> Cldr.LocaleDisplay.display_name "nl-BE"
96+
iex> Cldr.LocaleDisplay.display_name("nl-BE")
9097
{:ok, "Dutch (Belgium)"}
9198
92-
iex> Cldr.LocaleDisplay.display_name "nl-BE", language_display: :dialect
99+
iex> Cldr.LocaleDisplay.display_name("nl-BE", language_display: :dialect)
93100
{:ok, "Flemish"}
94101
95102
"""
96-
@spec display_name(Cldr.Locale.locale_reference(), display_options()) ::
103+
@spec display_name(Locale.locale_reference(), display_options()) ::
97104
{:ok, String.t()} | {:error, {module(), String.t()}}
98105

99106
def display_name(language_tag, options \\ [])
@@ -164,14 +171,14 @@ defmodule Cldr.LocaleDisplay do
164171
and using the [CLDR locale display name algorithm](https://unicode-org.github.io/cldr/ldml/tr35-general.html#locale_display_name_algorithm)
165172
produces a string suitable for presentation.
166173
167-
## Arguments
174+
### Arguments
168175
169176
* `language_tag` is any `t:Cldr.LanguageTag` or
170177
a locale name as an atom or string.
171178
172179
* `options` is a keyword list of options.
173180
174-
## Options
181+
### Options
175182
176183
* `:language_display` determines if a language
177184
is displayed in `:standard` format (the default)
@@ -190,32 +197,38 @@ defmodule Cldr.LocaleDisplay do
190197
* `:backend` is any module that includes `use Cldr` and therefore
191198
is a `Cldr` backend module. The default is `Cldr.default_backend!/0`.
192199
193-
## Returns
200+
### Returns
194201
195202
* a string representation of the language tag
196203
suitable for presentation purposes or
197204
198205
* raises an exception.
199206
200-
## Examples
207+
### Notes
208+
209+
* The difference between `language_display: :standard` and
210+
`:dialect` is related to how compound languages are displayed.
211+
See the examples for "nl-BE" below.
212+
213+
### Examples
201214
202-
iex> Cldr.LocaleDisplay.display_name! "en"
215+
iex> Cldr.LocaleDisplay.display_name!("en")
203216
"English"
204217
205-
iex> Cldr.LocaleDisplay.display_name! "en-US", language_display: :dialect
218+
iex> Cldr.LocaleDisplay.display_name!("en-US", language_display: :dialect)
206219
"American English"
207220
208-
iex> Cldr.LocaleDisplay.display_name! "en-US"
221+
iex> Cldr.LocaleDisplay.display_name!("en-US")
209222
"English (United States)"
210223
211-
iex> Cldr.LocaleDisplay.display_name! "en-US-u-ca-gregory-cu-aud", language_display: :dialect
224+
iex> Cldr.LocaleDisplay.display_name!("en-US-u-ca-gregory-cu-aud", language_display: :dialect)
212225
"American English (Gregorian Calendar, Currency: A$)"
213226
214-
iex> Cldr.LocaleDisplay.display_name! "en-US-u-ca-gregory-cu-aud", locale: "fr", language_display: :dialect
227+
iex> Cldr.LocaleDisplay.display_name!("en-US-u-ca-gregory-cu-aud", locale: "fr", language_display: :dialect)
215228
"anglais américain (calendrier grégorien, devise : A$)"
216229
217230
"""
218-
@spec display_name!(Cldr.Locale.locale_reference(), display_options()) ::
231+
@spec display_name!(Locale.locale_reference(), display_options()) ::
219232
String.t() | no_return()
220233

221234
def display_name!(language_tag, options \\ []) do

‎lib/cldr/locale_display/extension.ex‎

Lines changed: 1 addition & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -1,8 +1,6 @@
11
defmodule Cldr.LocaleDisplay.Extension do
2-
@moduledoc """
2+
@moduledoc false
33

4-
5-
"""
64
import Cldr.LocaleDisplay, only: [join_field_values: 2]
75

86
# locale_display_pattern: %{

‎lib/cldr/locale_display/private_use.ex‎

Lines changed: 1 addition & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -1,8 +1,6 @@
11
defmodule Cldr.LocaleDisplay.PrivateUse do
2-
@moduledoc """
2+
@moduledoc false
33

4-
5-
"""
64
import Cldr.LocaleDisplay, only: [join_field_values: 2]
75

86
def display_name(private_use, options) do

‎lib/cldr/locale_display/t.ex‎

Lines changed: 1 addition & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -1,8 +1,5 @@
11
defmodule Cldr.LocaleDisplay.T do
2-
@moduledoc """
3-
4-
5-
"""
2+
@moduledoc false
63

74
import Cldr.LocaleDisplay,
85
only: [get_display_preference: 2, join_field_values: 2, replace_parens_with_brackets: 1]

‎lib/cldr/locale_display/u.ex‎

Lines changed: 1 addition & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -1,8 +1,5 @@
11
defmodule Cldr.LocaleDisplay.U do
2-
@moduledoc """
3-
4-
5-
"""
2+
@moduledoc false
63

74
import Cldr.LocaleDisplay,
85
only: [get_display_preference: 2, join_field_values: 2, replace_parens_with_brackets: 1]

0 commit comments

Comments
 (0)