Cldr.Unit.display_name

You're seeing just the function display_name, go back to Cldr.Unit module for more information.

display_name(unit, options \\ [])

Returns the localized display name for a unit.

The returned text is generally suitable for including in UI elements such as selection boxes.

Arguments

unit is any t:Cldr.Unit or any unit name returned by Cldr.Unit.known_units/0.
options is a keyword list of options.

Options

:locale is any valid locale name returned by Cldr.known_locale_names/0 or a Cldr.LanguageTag struct. The default is Cldr.get_locale/0.
backend is any module that includes use Cldr and therefore is a Cldr backend module. The default is Cldr.default_backend!/0.
:style is one of those returned by Cldr.Unit.available_styles. The current styles are :long, :short and :narrow. The default is style: :long.

Examples

iex> Cldr.Unit.display_name :liter
"liters"

iex> Cldr.Unit.display_name :liter, locale: "fr"
"litres"

iex> Cldr.Unit.display_name :liter, locale: "fr", style: :short
"l"