Skip to content

Commit 243994f

Browse files
committed
Add note to to_rfc3339_opts
1 parent 29de6a0 commit 243994f

File tree

1 file changed

+8
-5
lines changed

1 file changed

+8
-5
lines changed

src/datetime/mod.rs

Lines changed: 8 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -633,12 +633,15 @@ impl<Tz: TimeZone> DateTime<Tz> {
633633
result
634634
}
635635

636-
/// Return an RFC 3339 and ISO 8601 date and time string with subseconds
637-
/// formatted as per `SecondsFormat`.
636+
/// Return an RFC 3339 and ISO 8601 date and time string with subseconds formatted as per
637+
/// `SecondsFormat`.
638638
///
639-
/// If `use_z` is true and the timezone is UTC (offset 0), uses `Z` as
640-
/// per [`Fixed::TimezoneOffsetColonZ`]. If `use_z` is false, uses
641-
/// [`Fixed::TimezoneOffsetColon`]
639+
/// If `use_z` is `false` and the time zone is UTC the offset will be formatted as `+00:00`.
640+
/// If `use_z` is `true` the offset will be formatted as `Z` instead.
641+
///
642+
/// Note that if the year of the `DateTime` is outside of the range 0 through 9999 then the date
643+
/// while be formatted as an expanded representation according to ISO 8601. This makes the
644+
/// string incompatible with RFC 3339.
642645
///
643646
/// # Examples
644647
///

0 commit comments

Comments
 (0)