docs: Update docs for FileTime::to_dos_date_time

sorairolake · Sep 29, 2024 · 4dacb13 · 4dacb13
1 parent 4b1ad83
commit 4dacb13
Showing 1 changed file with 2 additions and 1 deletion.
diff --git a/src/file_time/dos_date_time.rs b/src/file_time/dos_date_time.rs
@@ -17,7 +17,8 @@ impl FileTime {
     /// as this `FileTime`. This date and time is used as the timestamp such as
     /// [FAT], [exFAT] or [ZIP] file format.
     ///
-    /// This method returns a `(date, time, resolution, offset)` tuple.
+    /// This method returns a `(date, time, resolution, offset)` tuple if the
+    /// result is [`Ok`].
     ///
     /// `date` and `time` represents the local date and time. This date and time
     /// has no notion of time zone. The resolution of MS-DOS date and time is 2