fix: fix doc for DateTime overflow panic

da2ce7 · josecelano · commit ddf4dc639bfd · 2023-03-28T16:37:50.000+01:00
diff --git a/src/shared/clock/mod.rs b/src/shared/clock/mod.rs
@@ -90,8 +90,8 @@ pub trait TimeNow: Time {
 ///
 /// # Panics
 ///
-/// Will panic if the input time cannot be converted to `DateTime::<Utc>`.
-/// <https://en.wikipedia.org/wiki/Year_2038_problem>
+/// Will panic if the input time cannot be converted to `DateTime::<Utc>`, internally using the `i64` type.
+/// (this will naturally happen in 292.5 billion years)
 #[must_use]
 pub fn convert_from_iso_8601_to_timestamp(iso_8601: &str) -> DurationSinceUnixEpoch {
     convert_from_datetime_utc_to_timestamp(&DateTime::<Utc>::from_str(iso_8601).unwrap())
@@ -103,8 +103,8 @@ pub fn convert_from_iso_8601_to_timestamp(iso_8601: &str) -> DurationSinceUnixEp
 ///
 /// # Panics
 ///
-/// Will panic if the input time overflows the u64 type.
-/// <https://en.wikipedia.org/wiki/Year_2038_problem>
+/// Will panic if the input time overflows the `u64` type.
+/// (this will naturally happen in 584.9 billion years)
 #[must_use]
 pub fn convert_from_datetime_utc_to_timestamp(datetime_utc: &DateTime<Utc>) -> DurationSinceUnixEpoch {
     DurationSinceUnixEpoch::from_secs(u64::try_from(datetime_utc.timestamp()).expect("Overflow of u64 seconds, very future!"))
@@ -116,8 +116,8 @@ pub fn convert_from_datetime_utc_to_timestamp(datetime_utc: &DateTime<Utc>) -> D
 ///
 /// # Panics
 ///
-/// Will panic if the input time overflows the i64 type.
-/// <https://en.wikipedia.org/wiki/Year_2038_problem>
+/// Will panic if the input time overflows the `u64` seconds overflows the `i64` type.
+/// (this will naturally happen in 292.5 billion years)
 #[must_use]
 pub fn convert_from_timestamp_to_datetime_utc(duration: DurationSinceUnixEpoch) -> DateTime<Utc> {
     DateTime::<Utc>::from_utc(
diff --git a/src/tracker/auth.rs b/src/tracker/auth.rs
@@ -120,8 +120,8 @@ impl ExpiringKey {
     ///
     /// # Panics
     ///
-    /// Will panic when the key timestamp overflows the ui64 type.
-    /// <https://en.wikipedia.org/wiki/Year_2038_problem>
+    /// Will panic when the key timestamp overflows the internal i64 type.
+    /// (this will naturally happen in 292.5 billion years)
     #[must_use]
     pub fn expiry_time(&self) -> chrono::DateTime<chrono::Utc> {
         convert_from_timestamp_to_datetime_utc(self.valid_until)
