Skip to content

Commit 21e2a18

Browse files
authored
Point out that AstronomicalSimulation is unofficial and users who are unsure probably want UmmAlQura instead (#7031)
Fixes #6210
1 parent 4cd20c9 commit 21e2a18

File tree

1 file changed

+7
-2
lines changed

1 file changed

+7
-2
lines changed

components/calendar/src/cal/hijri.rs

Lines changed: 7 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -97,8 +97,9 @@ pub trait Rules: Clone + Debug + crate::cal::scaffold::UnstableSealed {
9797

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

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

0 commit comments

Comments
 (0)