-
Notifications
You must be signed in to change notification settings - Fork 244
Improve the docs of Hijri AstronomicalSimulation #7325
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
base: main
Are you sure you want to change the base?
Changes from 1 commit
9d662be
502afaa
fd32ecf
496e3ea
b008147
117b0ad
ce865e3
File filter
Filter by extension
Conversations
Jump to
Diff view
Diff view
There are no files selected for viewing
| Original file line number | Diff line number | Diff line change |
|---|---|---|
|
|
@@ -129,12 +129,18 @@ pub trait Rules: Clone + Debug + crate::cal::scaffold::UnstableSealed { | |
|
|
||
| /// [`Hijri`] [`Rules`] based on an astronomical simulation for a particular location. | ||
| /// | ||
| /// 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. | ||
| /// The simulations use the relative positions of the Earth, moon, and sun to predict the | ||
| /// exact moment a new moon occurs. Because this is rarely the instant when a crescent | ||
| /// sighting occurs, the month start dates preducted by these rules will often be one or | ||
| /// more days earlier than actually observed. Applications using these rules should have | ||
| /// a method for adjusting the month start date based on human sightings. | ||
| /// | ||
| /// As floating point arithmetic degenerates for far-away dates, this falls back to | ||
| /// the tabular calendar at some point. | ||
| /// If you don't have a way to inject human sighting adjustments, you should probably use | ||
| /// [`UmmAlQura`], which uses the results of KACST's Mecca-based calculations and matches | ||
| /// ground truth in Saudi Arabia. | ||
|
||
| /// | ||
| /// The simulations are pre-computed for Gregorian years 1900 to 2140, falling back to | ||
| /// a tabular approximation outside that range. | ||
| /// | ||
| /// The precise behavior of this calendar may change in the future if: | ||
| /// - We decide to tweak the precise astronomical simulation used | ||
|
|
||
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
maybe say something like "These
Rulesshouldn't be used directly, but can form the basis for aRulesimplementation based on human sightings". The correction should be applied at theRuleslevel, not at theDatelevel (but I don't really see the point of using this if you can just write a sightingRules).There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
I made it say: