Skip to content

Point out that AstronomicalSimulation exists for semver and users who are unsure probably want UmmAlQura instead #7031

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.

Sign up for GitHub

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

Merged
merged 3 commits into from
Oct 6, 2025
Merged

Point out that AstronomicalSimulation exists for semver and users who are unsure probably want UmmAlQura instead #7031

Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
e5b8a33
Point out that AstronomicalSimulation exists for semver and users
hsivonen Oct 3, 2025
821bc16
Avoid mentioning semver or use cases
hsivonen Oct 6, 2025
b98ba00
Merge branch 'main' into simulated
hsivonen Oct 6, 2025
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
9 changes: 7 additions & 2 deletions components/calendar/src/cal/hijri.rs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -97,8 +97,9 @@ pub trait Rules: Clone + Debug + crate::cal::scaffold::UnstableSealed {

/// [`Hijri`] [`Rules`] based on an astronomical simulation for a particular location.
///
/// These simulations are known to not necessarily match sightings on the ground,
/// but are included for completeness.
/// These simulations are unofficial and are known to not necessarily match sightings
/// on the ground. Unless you know otherwise for sure, instead of this variant, use
/// [`UmmAlQura`], which uses the results of KACST's Mecca-based calculations.
#[derive(Copy, Clone, Debug)]
pub struct AstronomicalSimulation {
pub(crate) location: SimulatedLocation,
Expand Down Expand Up @@ -386,6 +387,10 @@ impl Hijri<AstronomicalSimulation> {
}

/// Creates a [`Hijri`] calendar using simulated sightings at Mecca.
///
/// These simulations are unofficial and are known to not necessarily match sightings
/// on the ground. Unless you know otherwise for sure, instead of this variant, use
/// [`Hijri::new_umm_al_qura`], which uses the results of KACST's Mecca-based calculations.
pub const fn new_simulated_mecca() -> Self {
Self(AstronomicalSimulation {
location: SimulatedLocation::Mecca,
Expand Down