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

Docs should explain IslamicObservational #6210

Open
hsivonen opened this issue Feb 28, 2025 · 3 comments
Open

Docs should explain IslamicObservational #6210

hsivonen opened this issue Feb 28, 2025 · 3 comments
Labels
C-calendar Component: Calendars

Comments

@hsivonen
Copy link
Member

Currently https://unicode-org.github.io/icu4x/rustdoc/icu_calendar/cal/struct.IslamicObservational.html says is "Islamic Observational Calendar (Default)".

The docs should explain at least:

  • That "observational" means an astronomical simulation of moon observability from a reference location on Earth.
  • That the reference location is Cairo and why it is Cairo. (The code comment points to Reingold's code, which says Cairo is a "sample location".)
  • Why this is "(Default)".
  • What use cases this variant is for relative to the other three variants.
@sffc
Copy link
Member

sffc commented Feb 28, 2025

Would it be smart to name the calendar IslamicCairo instead of IslamicObservational? Then we could add other reference locations on an as-needed basis.

@sffc
Copy link
Member

sffc commented Feb 28, 2025

Based on the regional calendar preferences, it seems that islamic is the preferred Hijri caliendar in EG and IL. In that sense, choosing Cairo as a reference point is maybe not a bad choice, but it would be good to gather data on the expectations of users in IL.

@hsivonen
Copy link
Member Author

hsivonen commented Mar 3, 2025

Would it be smart to name the calendar IslamicCairo instead of IslamicObservational? Then we could add other reference locations on an as-needed basis.

Is Cairo already included on an as-needed basis as opposed to Reingold using it as a sample?

Based on the regional calendar preferences, it seems that islamic is the preferred Hijri caliendar in EG and IL. In that sense, choosing Cairo as a reference point is maybe not a bad choice, but it would be good to gather data on the expectations of users in IL.

Many more regions have islamic their preferred Hijri calendar variant the CLDR data (though no region has it as the most preferred calendar in the data), but what does that data mean?

Does it mean that CLDR attests the regions to prefer the specific parameters used in ICU4C/J?

Does it mean that the regions prefer observational in the sense of actual local-to-region observation (as opposed to the parameters either in ICU4X or ICU4C)?

Does it mean something else?

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
C-calendar Component: Calendars
Projects
None yet
Development

No branches or pull requests

2 participants