Undocumented Types

[maennchen]

When generating docs for a CLDR Module, there's a lot of referenced types, that are not available through ExDoc because they've been hidden. (Probably @moduledoc false)

It would be nice if all the referenced types are actually documented.

Example ExDoc Output: https://github.com/jshmrtn/hygeia/runs/2791313937?check_suite_focus=true#step:9:11

``` Generating docs... warning: documentation references module "Cldr.Calendar.Gregorian" but it is hidden Warning: apps/hygeia_cldr/lib/hygeia_cldr.ex:1: HygeiaCldr.calendar_from_territory/1 warning: documentation references module "Cldr.Calendar.Gregorian" but it is hidden Warning: apps/hygeia_cldr/lib/hygeia_cldr.ex:1: HygeiaCldr.calendar_from_territory/1 warning: documentation references module "Cldr.Rfc5646.Parser" but it is hidden Warning: apps/hygeia_cldr/lib/hygeia_cldr.ex:1: HygeiaCldr.put_locale/1 warning: documentation references module "Cldr.Rfc5646.Parser" but it is hidden Warning: apps/hygeia_cldr/lib/hygeia_cldr.ex:1: HygeiaCldr.validate_locale/1 warning: documentation references "Cldr.Number.PluralRule.plural_type()" but it is hidden or private Warning: apps/hygeia_cldr/lib/hygeia_cldr.ex:1: HygeiaCldr.Number.Cardinal.plural_rule/3 warning: documentation references "Cldr.Number.PluralRule.plural_type()" but it is hidden or private Warning: apps/hygeia_cldr/lib/hygeia_cldr.ex:1: HygeiaCldr.Number.Ordinal.plural_rule/3 warning: documentation references "Cldr.Number.PluralRule.plural_type()" but it is hidden or private Warning: apps/hygeia_cldr/lib/hygeia_cldr.ex:1: HygeiaCldr.Number.PluralRule.Range.plural_rule/3 warning: documentation references "Cldr.Number.PluralRule.plural_type()" but it is hidden or private Warning: apps/hygeia_cldr/lib/hygeia_cldr.ex:1: HygeiaCldr.Number.PluralRule.Range.plural_rule/3 warning: documentation references "Cldr.Number.PluralRule.plural_type()" but it is hidden or private Warning: apps/hygeia_cldr/lib/hygeia_cldr.ex:1: HygeiaCldr.Number.PluralRule.Range.plural_rule/3 warning: documentation references "Cldr.Unit.known_gender/0" but it is undefined or private Warning: apps/hygeia_cldr/lib/hygeia_cldr.ex:1: HygeiaCldr.Unit.to_iolist/2 warning: documentation references "Cldr.Unit.default_gender/1" but it is undefined or private Warning: apps/hygeia_cldr/lib/hygeia_cldr.ex:1: HygeiaCldr.Unit.to_iolist/2 warning: documentation references "Cldr.Unit.available_styles/0" but it is undefined or private Warning: apps/hygeia_cldr/lib/hygeia_cldr.ex:1: HygeiaCldr.Unit.to_iolist!/2 warning: documentation references "Cldr.Unit.known_gender/0" but it is undefined or private Warning: apps/hygeia_cldr/lib/hygeia_cldr.ex:1: HygeiaCldr.Unit.to_iolist!/2 warning: documentation references "Cldr.Unit.default_gender/1" but it is undefined or private Warning: apps/hygeia_cldr/lib/hygeia_cldr.ex:1: HygeiaCldr.Unit.to_iolist!/2 warning: documentation references "Cldr.Unit.known_gender/0" but it is undefined or private Warning: apps/hygeia_cldr/lib/hygeia_cldr.ex:1: HygeiaCldr.Unit.to_string/2 warning: documentation references "Cldr.Unit.default_gender/1" but it is undefined or private Warning: apps/hygeia_cldr/lib/hygeia_cldr.ex:1: HygeiaCldr.Unit.to_string/2 warning: documentation references "Cldr.Unit.known_gender/0" but it is undefined or private Warning: apps/hygeia_cldr/lib/hygeia_cldr.ex:1: HygeiaCldr.Unit.to_string!/2 warning: documentation references "Cldr.Unit.default_gender/1" but it is undefined or private Warning: apps/hygeia_cldr/lib/hygeia_cldr.ex:1: HygeiaCldr.Unit.to_string!/2 View "html" docs at "doc/index.html" warning: documentation references module "Cldr.Calendar.Gregorian" but it is hidden Warning: apps/hygeia_cldr/lib/hygeia_cldr.ex:1: HygeiaCldr.calendar_from_territory/1 warning: documentation references module "Cldr.Calendar.Gregorian" but it is hidden Warning: apps/hygeia_cldr/lib/hygeia_cldr.ex:1: HygeiaCldr.calendar_from_territory/1 warning: documentation references module "Cldr.Rfc5646.Parser" but it is hidden Warning: apps/hygeia_cldr/lib/hygeia_cldr.ex:1: HygeiaCldr.put_locale/1 warning: documentation references module "Cldr.Rfc5646.Parser" but it is hidden Warning: apps/hygeia_cldr/lib/hygeia_cldr.ex:1: HygeiaCldr.validate_locale/1 warning: documentation references "Cldr.Number.PluralRule.plural_type()" but it is hidden or private Warning: apps/hygeia_cldr/lib/hygeia_cldr.ex:1: HygeiaCldr.Number.Cardinal.plural_rule/3 warning: documentation references "Cldr.Number.PluralRule.plural_type()" but it is hidden or private Warning: apps/hygeia_cldr/lib/hygeia_cldr.ex:1: HygeiaCldr.Number.Ordinal.plural_rule/3 warning: documentation references "Cldr.Number.PluralRule.plural_type()" but it is hidden or private Warning: apps/hygeia_cldr/lib/hygeia_cldr.ex:1: HygeiaCldr.Number.PluralRule.Range.plural_rule/3 warning: documentation references "Cldr.Number.PluralRule.plural_type()" but it is hidden or private Warning: apps/hygeia_cldr/lib/hygeia_cldr.ex:1: HygeiaCldr.Number.PluralRule.Range.plural_rule/3 warning: documentation references "Cldr.Number.PluralRule.plural_type()" but it is hidden or private Warning: apps/hygeia_cldr/lib/hygeia_cldr.ex:1: HygeiaCldr.Number.PluralRule.Range.plural_rule/3 warning: documentation references "Cldr.Unit.known_gender/0" but it is undefined or private Warning: apps/hygeia_cldr/lib/hygeia_cldr.ex:1: HygeiaCldr.Unit.to_iolist/2 warning: documentation references "Cldr.Unit.default_gender/1" but it is undefined or private Warning: apps/hygeia_cldr/lib/hygeia_cldr.ex:1: HygeiaCldr.Unit.to_iolist/2 warning: documentation references "Cldr.Unit.available_styles/0" but it is undefined or private Warning: apps/hygeia_cldr/lib/hygeia_cldr.ex:1: HygeiaCldr.Unit.to_iolist!/2 warning: documentation references "Cldr.Unit.known_gender/0" but it is undefined or private Warning: apps/hygeia_cldr/lib/hygeia_cldr.ex:1: HygeiaCldr.Unit.to_iolist!/2 warning: documentation references "Cldr.Unit.default_gender/1" but it is undefined or private Warning: apps/hygeia_cldr/lib/hygeia_cldr.ex:1: HygeiaCldr.Unit.to_iolist!/2 warning: documentation references "Cldr.Unit.known_gender/0" but it is undefined or private Warning: apps/hygeia_cldr/lib/hygeia_cldr.ex:1: HygeiaCldr.Unit.to_string/2 warning: documentation references "Cldr.Unit.default_gender/1" but it is undefined or private Warning: apps/hygeia_cldr/lib/hygeia_cldr.ex:1: HygeiaCldr.Unit.to_string/2 warning: documentation references "Cldr.Unit.known_gender/0" but it is undefined or private Warning: apps/hygeia_cldr/lib/hygeia_cldr.ex:1: HygeiaCldr.Unit.to_string!/2 warning: documentation references "Cldr.Unit.default_gender/1" but it is undefined or private Warning: apps/hygeia_cldr/lib/hygeia_cldr.ex:1: HygeiaCldr.Unit.to_string!/2 View "epub" docs at "doc/Hygeia.epub" ```

Versions

Elixir: 1.12.1
Erlang: 24.0

* cldr_utils 2.16.0 (Hex package) (mix)
* ex_cldr 2.22.1 (Hex package) (mix)
* ex_cldr_calendars 1.14.1 (Hex package) (mix)
* ex_cldr_currencies 2.9.1 (Hex package) (mix)
* ex_cldr_dates_times 2.7.2 (Hex package) (mix)
* ex_cldr_languages 0.2.2 (Hex package) (mix)
* ex_cldr_lists 2.8.0 (Hex package) (mix)
* ex_cldr_numbers 2.18.2 (Hex package) (mix)
* ex_cldr_units 3.6.0 (Hex package) (mix)

Cldr Module:

https://github.com/jshmrtn/hygeia/blob/master/apps/hygeia_cldr/lib/hygeia_cldr.ex

defmodule HygeiaCldr do
  @moduledoc false

  use Cldr,
    default_locale: "en-CH",
    locales: ["en-CH", "de-CH", "fr-CH", "it-CH"],
    gettext: HygeiaGettext,
    data_dir: "./priv/cldr",
    otp_app: :hygeia_cldr,
    providers: [Cldr.Number, Cldr.List, Cldr.Calendar, Cldr.DateTime, Cldr.Unit, Cldr.Language],
    generate_docs: true,
    force_locale_download: false
end

[kipcole9]

Good suggestion and I'll see what I can do over the weekend.

[kipcole9]

Not forgotten - just challenged on a few non-development priorities. I will definitely get these types fixed in the next release which I plan for the next 2 weeks.

[maennchen]

@kipcole9 No worries, this is not a pressing issue for me. I just thought it would be nice if this was clean long-term :)

[kipcole9]

Totally agree with you and sorry this is taken longer than I expected. I bunch of tiger maintenance activities got in the way but should al be cleared I all br cleared over this weekend.

Sent from my iPhone

On 19 Aug 2021, at 21:41, Jonatan Männchen @.***> wrote:

 @kipcole9 No worries, this is not a pressing issue for me. I just thought it would be nice if this was clean long-term :)

— You are receiving this because you were mentioned. Reply to this email directly, view it on GitHub, or unsubscribe.

[kipcole9]

I have just published:

• ex_cldr version 2.23.1
• ex_cldr_units 3.7.1
• ex_cldr_calendars 1.15.2

Based upon a test application using the same backend configuration as the one you kindly provided I believe the doc errors have now been banished.

Please do let me know if you see any other issues or errors. Apologies on the poor time-to-fix for this issue, definitely didn't meet my own expectations. I will close the issue if you no longer see the errors you reported.

[maennchen]

@kipcole9 Seems like all the errors vanished: https://github.com/jshmrtn/hygeia/runs/3397964370?check_suite_focus=true

Thanks a lot!