Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

HourCycle docs are wrong #6030

Closed
hsivonen opened this issue Jan 23, 2025 · 0 comments · Fixed by #6038
Closed

HourCycle docs are wrong #6030

hsivonen opened this issue Jan 23, 2025 · 0 comments · Fixed by #6038

Comments

@hsivonen
Copy link
Member

https://unicode-org.github.io/icu4x/rustdoc/icu/locale/preferences/extensions/unicode/keywords/enum.HourCycle.html says:

H11
Hour system using 1–12; corresponds to ‘h’ in patterns
H12
Hour system using 0–23; corresponds to ‘H’ in patterns
H23
Hour system using 0–11; corresponds to ‘K’ in patterns
H24
Hour system using 1–24; corresponds to ‘k’ in pattern

The doc for H24 is correct, but the other three have a mismatch between the doc and the enum value.

Additionally, the docs should try to make an effort to minimize misuse. Specifically, the docs should say:

H24 isn't used anywhere and is not what's usually understood as the "24-hour clock".
H11 is only used in Japan.
H23 is "24-hour clock".
H12 is "12-hour clock".

hsivonen added a commit to hsivonen/icu4x that referenced this issue Jan 27, 2025
hsivonen added a commit that referenced this issue Jan 28, 2025
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging a pull request may close this issue.

1 participant