diff --git a/README.md b/README.md index 46336db..3ef5c05 100644 --- a/README.md +++ b/README.md @@ -1,6 +1,6 @@ # Cldr HTML -`Phoenix.HTML.Form.select/4` helper functions for CLDR. The functions in this library produce localised selection tags for HTML forms for: +Phoenix form select helper functions for CLDR. The functions in this library produce localised selection tags for HTML forms for: * Currencies * Units diff --git a/lib/cldr_html.ex b/lib/cldr_html.ex index 1037ddc..46c2f34 100644 --- a/lib/cldr_html.ex +++ b/lib/cldr_html.ex @@ -1,6 +1,6 @@ defmodule Cldr.HTML do @moduledoc """ - Implements `Phoenix.HTML.Form.select/4` specifically + Implements an HTML Form select specifically for localized display of [Cldr](https://hex.pm/packages/ex_cldr)-based data. """ diff --git a/lib/cldr_html_currencies.ex b/lib/cldr_html_currencies.ex index 4a7cae3..5a78a86 100644 --- a/lib/cldr_html_currencies.ex +++ b/lib/cldr_html_currencies.ex @@ -1,7 +1,7 @@ if match?({:module, _}, Code.ensure_compiled(Cldr.Currency)) do defmodule Cldr.HTML.Currency do @moduledoc """ - Implements `Phoenix.HTML.Form.select/4` specifically for + Implements an HTML Form select specifically localised currency display. """ @@ -29,7 +29,7 @@ if match?({:module, _}, Code.ensure_compiled(Cldr.Currency)) do ## Options - For select options see `Phoenix.HTML.Form.select/4` + For select options see `Phoenix.HTML.Form.options_for_select/2` * `:currencies` defines the list of currencies to be displayed in the the `select` tag. The list defaults to @@ -60,10 +60,10 @@ if match?({:module, _}, Code.ensure_compiled(Cldr.Currency)) do * `:selected` identifies the currency that is to be selected by default in the `select` tag. The default is `nil`. This - is passed unmodified to `Phoenix.HTML.Form.select/4` + is passed unmodified to the form generator. * `:prompt` is a prompt displayed at the top of the select - box. This is passed unmodified to `Phoenix.HTML.Form.select/4` + box. This is passed unmodified to the form generator. # Examples diff --git a/lib/cldr_html_locale.ex b/lib/cldr_html_locale.ex index 839722d..c91263f 100644 --- a/lib/cldr_html_locale.ex +++ b/lib/cldr_html_locale.ex @@ -1,7 +1,7 @@ if match?({:module, _}, Code.ensure_compiled(Cldr.LocaleDisplay)) do defmodule Cldr.HTML.Locale do @moduledoc """ - Implements `Phoenix.HTML.Form.select/4` specifically for + Implements an HTML Form select specifically localised locale display. """ @@ -47,7 +47,7 @@ if match?({:module, _}, Code.ensure_compiled(Cldr.LocaleDisplay)) do ## Options - For select options see `Phoenix.HTML.Form.select/4` + For select options see `Phoenix.HTML.Form.options_for_select/2` * `:locales` defines the list of locales to be displayed in the the `select` tag. The list defaults to @@ -82,10 +82,10 @@ if match?({:module, _}, Code.ensure_compiled(Cldr.LocaleDisplay)) do * `:selected` identifies the locale that is to be selected by default in the `select` tag. The default is `nil`. This - is passed to `Phoenix.HTML.Form.select/4` + is passed to the form generator. * `:prompt` is a prompt displayed at the top of the select - box. This is passed unmodified to `Phoenix.HTML.Form.select/4` + box. This is passed unmodified to the form generator. ## Notes diff --git a/lib/cldr_html_territories.ex b/lib/cldr_html_territories.ex index 2d02926..82b7fcb 100644 --- a/lib/cldr_html_territories.ex +++ b/lib/cldr_html_territories.ex @@ -1,7 +1,7 @@ if match?({:module, _}, Code.ensure_compiled(Cldr.Territory)) do defmodule Cldr.HTML.Territory do @moduledoc """ - Implements `Phoenix.HTML.Form.select/4` specifically for + Implements an HTML Form select specifically localised territory display. """ @@ -45,7 +45,7 @@ if match?({:module, _}, Code.ensure_compiled(Cldr.Territory)) do ## Options - For select options see `Phoenix.HTML.Form.select/4` + For select options see `Phoenix.HTML.Form.options_for_select/2` * `:territories` defines the list of territories to be displayed in the the `select` tag. The list defaults to @@ -80,10 +80,10 @@ if match?({:module, _}, Code.ensure_compiled(Cldr.Territory)) do * `:selected` identifies the territory that is to be selected by default in the `select` tag. The default is `nil`. This - is passed unmodified to `Phoenix.HTML.Form.select/4` + is passed unmodified to the form generator. * `:prompt` is a prompt displayed at the top of the select - box. This is passed unmodified to `Phoenix.HTML.Form.select/4` + box. This is passed unmodified to the form generator. # Examples diff --git a/lib/cldr_html_units.ex b/lib/cldr_html_units.ex index 41c1a3d..466bdb1 100644 --- a/lib/cldr_html_units.ex +++ b/lib/cldr_html_units.ex @@ -1,7 +1,7 @@ if match?({:module, _}, Code.ensure_compiled(Cldr.Unit)) do defmodule Cldr.HTML.Unit do @moduledoc """ - Implements `Phoenix.HTML.Form.select/4` specifically for + Implements an HTML Form select specifically localised unit display. """ @@ -17,19 +17,19 @@ if match?({:module, _}, Code.ensure_compiled(Cldr.Unit)) do @doc """ Generate an HTML select tag for a unit list - that can be used with a `Phoenix.HTML.Form.t`. + that can be used with a `t:Phoenix.HTML.Form.t/0`. ## Arguments - * A `t:Phoenix.HTML.Form` form + * A `t:Phoenix.HTML.Form.t/0` form - * A `t:Phoenix.HTML.Form.field` field + * A `t:Phoenix.HTML.Form.field/0` field * A `t:Keyword` list of options ## Options - For select options see `Phoenix.HTML.Form.select/4` + For select options see `Phoenix.HTML.Form.options_for_select/2` * `:units` is a list of units to be displayed in the select. See `Cldr.Unit.known_units/0` and @@ -61,10 +61,10 @@ if match?({:module, _}, Code.ensure_compiled(Cldr.Unit)) do * `:selected` identifies the unit that is to be selected by default in the `select` tag. The default is `nil`. This - is passed unmodified to `Phoenix.HTML.Form.select/4` + is passed unmodified to the form generator. * `:prompt` is a prompt displayed at the top of the select - box. This is passed unmodified to `Phoenix.HTML.Form.select/4` + box. This is passed unmodified to the form generator. # Examples