Skip to content

Commit 6dbf170

Browse files
authored
Cite Reingold and Shaukat in the AstronomicalSimulation docs (#7332)
Split from #7325 Depends on #7331
1 parent 2d0ff91 commit 6dbf170

File tree

1 file changed

+4
-1
lines changed

1 file changed

+4
-1
lines changed

components/calendar/src/cal/hijri.rs

Lines changed: 4 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -129,7 +129,8 @@ pub trait Rules: Clone + Debug + crate::cal::scaffold::UnstableSealed {
129129

130130
/// [`Hijri`] [`Rules`] based on an astronomical simulation for a particular location.
131131
///
132-
/// These simulations are unofficial and are known to not necessarily match sightings
132+
/// These simulations use methods published by E. M. Reingold, S. K. Shaukat, et al.[^1]
133+
/// These methods are not officially recognized in any region and do not match sightings
133134
/// on the ground. Unless you know otherwise for sure, instead of this variant, use
134135
/// [`UmmAlQura`], which uses the results of KACST's Mecca-based calculations.
135136
///
@@ -142,6 +143,8 @@ pub trait Rules: Clone + Debug + crate::cal::scaffold::UnstableSealed {
142143
///
143144
/// This corresponds to the `"islamic-rgsa"` [CLDR calendar](https://unicode.org/reports/tr35/#UnicodeCalendarIdentifier)
144145
/// if constructed with [`Hijri::new_simulated_mecca()`].
146+
///
147+
/// [^1]: See [calendrical_calculations::islamic::observational_islamic_from_fixed]
145148
#[derive(Copy, Clone, Debug, PartialEq, Eq)]
146149
pub struct AstronomicalSimulation {
147150
pub(crate) location: SimulatedLocation,

0 commit comments

Comments
 (0)