#1577: Changed years_since documentation to match its implementation

chronotope · Apr 29, 2024 · 7e25ffb · 7e25ffb
1 parent 352a352
commit 7e25ffb
Show file tree

Hide file tree

Showing 2 changed files with 2 additions and 2 deletions.
diff --git a/src/datetime/mod.rs b/src/datetime/mod.rs
@@ -594,7 +594,7 @@ impl<Tz: TimeZone> DateTime<Tz> {
     ///
     /// # Errors
     ///
-    /// Returns `None` if `base < self`.
+    /// Returns `None` if `base > self`.
     #[must_use]
     pub fn years_since(&self, base: Self) -> Option<u32> {
         let mut years = self.year() - base.year();

diff --git a/src/naive/date/mod.rs b/src/naive/date/mod.rs
@@ -1136,7 +1136,7 @@ impl NaiveDate {
     ///
     /// # Errors
     ///
-    /// Returns `None` if `base < self`.
+    /// Returns `None` if `base > self`.
     #[must_use]
     pub const fn years_since(&self, base: Self) -> Option<u32> {
         let mut years = self.year() - base.year();