Document return value due to soundness issue

time-rs · Nov 30, 2020 · 288c942 · 288c942
1 parent 7d353c8
commit 288c942
Show file tree

Hide file tree

Showing 2 changed files with 6 additions and 0 deletions.
diff --git a/src/offset_date_time.rs b/src/offset_date_time.rs
@@ -63,6 +63,9 @@ impl OffsetDateTime {
     /// assert!(OffsetDateTime::now_local().is_ok());
     /// # }
     /// ```
+    ///
+    /// Due to a [soundness bug](https://github.com/time-rs/time/issues/293),
+    /// the error value is currently always returned on Unix-like platforms.
     #[cfg(feature = "local-offset")]
     #[cfg_attr(__time_03_docs, doc(cfg(feature = "local-offset")))]
     pub fn now_local() -> Result<Self, error::IndeterminateOffset> {

diff --git a/src/utc_offset.rs b/src/utc_offset.rs
@@ -130,6 +130,9 @@ impl UtcOffset {
     /// assert!(local_offset.is_ok());
     /// # }
     /// ```
+    ///
+    /// Due to a [soundness bug](https://github.com/time-rs/time/issues/293),
+    /// the error value is currently always returned on Unix-like platforms.
     #[cfg(feature = "local-offset")]
     #[cfg_attr(__time_03_docs, doc(cfg(feature = "local-offset")))]
     pub fn local_offset_at(datetime: OffsetDateTime) -> Result<Self, error::IndeterminateOffset> {