itsscb/chrono
1
0
Fork 0
mirror of https://github.com/chronotope/chrono.git synced 2025-10-27 11:33:50 +00:00
Code Issues Packages Projects Releases Wiki Activity

Update duration docs for oldtime feature (#484)

Browse Source 
The main crate docs made some claims about the Duration type that became
incorrect with the new oldtime feature (#478).

Per @jhpratt.
This commit is contained in:
Nikhil Benesch 2020-09-26 10:57:33 -04:00 committed by GitHub
parent 70432bc5b6
commit 1402e8dd5e
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
2 changed files with 24 additions and 10 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

17
README.md
View File

@ -77,15 +77,22 @@ See the [cargo docs][] for examples of specifying features.
### Duration ### Duration
Chrono currently uses Chrono currently uses its own [`Duration`] type to represent the magnitude
the [`time::Duration`](https://docs.rs/time/0.1.40/time/struct.Duration.html) type of a time span. Since this has the same name as the newer, standard type for
from the `time` crate to represent the magnitude of a time span. duration, the reference will refer this type as `OldDuration`.
Since this has the same name as the newer, standard type for duration,
the reference will refer this type as `OldDuration`.
Note that this is an "accurate" duration represented as seconds and Note that this is an "accurate" duration represented as seconds and
nanoseconds and does not represent "nominal" components such as days or nanoseconds and does not represent "nominal" components such as days or
months. months.
When the `oldtime` feature is enabled, [`Duration`] is an alias for the
[`time::Duration`](https://docs.rs/time/0.1.40/time/struct.Duration.html)
type from v0.1 of the time crate. time v0.1 is deprecated, so new code
should disable the `oldtime` feature and use the `chrono::Duration` type
instead. The `oldtime` feature is enabled by default for backwards
compatibility, but future versions of Chrono are likely to remove the
feature entirely.
Chrono does not yet natively support Chrono does not yet natively support
the standard [`Duration`](https://doc.rust-lang.org/std/time/struct.Duration.html) type, the standard [`Duration`](https://doc.rust-lang.org/std/time/struct.Duration.html) type,
but it will be supported in the future. but it will be supported in the future.

17
src/lib.rs
View File

@ -64,15 +64,22 @@
//! //!
//! ### Duration //! ### Duration
//! //!
//! Chrono currently uses //! Chrono currently uses its own [`Duration`] type to represent the magnitude
//! the [`time::Duration`](https://docs.rs/time/0.1.40/time/struct.Duration.html) type //! of a time span. Since this has the same name as the newer, standard type for
//! from the `time` crate to represent the magnitude of a time span. //! duration, the reference will refer this type as `OldDuration`.
//! Since this has the same name as the newer, standard type for duration, //!
//! the reference will refer this type as `OldDuration`.
//! Note that this is an "accurate" duration represented as seconds and //! Note that this is an "accurate" duration represented as seconds and
//! nanoseconds and does not represent "nominal" components such as days or //! nanoseconds and does not represent "nominal" components such as days or
//! months. //! months.
//! //!
//! When the `oldtime` feature is enabled, [`Duration`] is an alias for the
//! [`time::Duration`](https://docs.rs/time/0.1.40/time/struct.Duration.html)
//! type from v0.1 of the time crate. time v0.1 is deprecated, so new code
//! should disable the `oldtime` feature and use the `chrono::Duration` type
//! instead. The `oldtime` feature is enabled by default for backwards
//! compatibility, but future versions of Chrono are likely to remove the
//! feature entirely.
//!
//! Chrono does not yet natively support //! Chrono does not yet natively support
//! the standard [`Duration`](https://doc.rust-lang.org/std/time/struct.Duration.html) type, //! the standard [`Duration`](https://doc.rust-lang.org/std/time/struct.Duration.html) type,
//! but it will be supported in the future. //! but it will be supported in the future.