xeos
/
chrono
1
0
Fork 0
Code Issues Pull Requests Releases Wiki Activity

Merge pull request #316 from GuillaumeGomez/doc-test 

Add doc-comment to test README examples and fix README examples
This commit is contained in:
Brandon W Maister 2019-05-01 22:07:13 -04:00 committed by GitHub
parent 1407309b87 b7003373f2
commit 96c451ec20
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
3 changed files with 17 additions and 10 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

1
Cargo.toml
View File

@ -40,6 +40,7 @@ serde_json = { version = "1" }
serde_derive = { version = "1" } serde_derive = { version = "1" }
bincode = { version = "0.8.0" } bincode = { version = "0.8.0" }
num-iter = { version = "0.1.35", default-features = false } num-iter = { version = "0.1.35", default-features = false }
doc-comment = "0.3"
[package.metadata.docs.rs] [package.metadata.docs.rs]
all-features = true all-features = true

6
README.md
View File

@ -172,11 +172,13 @@ Addition and subtraction is also supported.
The following illustrates most supported operations to the date and time: The following illustrates most supported operations to the date and time:
```rust ```rust
extern crate time;
use chrono::prelude::*; use chrono::prelude::*;
use time::Duration; use time::Duration;
// assume this returned `2014-11-28T21:45:59.324310806+09:00`: // assume this returned `2014-11-28T21:45:59.324310806+09:00`:
let dt = Local::now(); let dt = FixedOffset::east(9*3600).ymd(2014, 11, 28).and_hms_nano(21, 45, 59, 324310806);
// property accessors // property accessors
assert_eq!((dt.year(), dt.month(), dt.day()), (2014, 11, 28)); assert_eq!((dt.year(), dt.month(), dt.day()), (2014, 11, 28));
@ -312,7 +314,7 @@ to get the number of additional number of nanoseconds.
```rust ```rust
// We need the trait in scope to use Utc::timestamp(). // We need the trait in scope to use Utc::timestamp().
use chrono::TimeZone; use chrono::{DateTime, TimeZone, Utc};
// Construct a datetime from epoch: // Construct a datetime from epoch:
let dt = Utc.timestamp(1_500_000_000, 0); let dt = Utc.timestamp(1_500_000_000, 0);

20
src/lib.rs
View File

@ -158,15 +158,15 @@
//! The following illustrates most supported operations to the date and time: //! The following illustrates most supported operations to the date and time:
//! //!
//! ```rust //! ```rust
//! # extern crate chrono; extern crate time; fn main() { //! # extern crate chrono;
//! extern crate time;
//!
//! # fn main() {
//! use chrono::prelude::*; //! use chrono::prelude::*;
//! use time::Duration; //! use time::Duration;
//! //!
//! # /* we intentionally fake the datetime...
//! // assume this returned `2014-11-28T21:45:59.324310806+09:00`: //! // assume this returned `2014-11-28T21:45:59.324310806+09:00`:
//! let dt = Local::now(); //! let dt = FixedOffset::east(9*3600).ymd(2014, 11, 28).and_hms_nano(21, 45, 59, 324310806);
//! # */ // up to here. we now define a fixed datetime for the illustrative purpose.
//! # let dt = FixedOffset::east(9*3600).ymd(2014, 11, 28).and_hms_nano(21, 45, 59, 324310806);
//! //!
//! // property accessors //! // property accessors
//! assert_eq!((dt.year(), dt.month(), dt.day()), (2014, 11, 28)); //! assert_eq!((dt.year(), dt.month(), dt.day()), (2014, 11, 28));
@ -302,10 +302,8 @@
//! to get the number of additional number of nanoseconds. //! to get the number of additional number of nanoseconds.
//! //!
//! ```rust //! ```rust
//! # use chrono::DateTime;
//! # use chrono::Utc;
//! // We need the trait in scope to use Utc::timestamp(). //! // We need the trait in scope to use Utc::timestamp().
//! use chrono::TimeZone; //! use chrono::{DateTime, TimeZone, Utc};
//! //!
//! // Construct a datetime from epoch: //! // Construct a datetime from epoch:
//! let dt = Utc.timestamp(1_500_000_000, 0); //! let dt = Utc.timestamp(1_500_000_000, 0);
@ -413,6 +411,12 @@ extern crate num_traits;
extern crate rustc_serialize; extern crate rustc_serialize;
#[cfg(feature = "serde")] #[cfg(feature = "serde")]
extern crate serde as serdelib; extern crate serde as serdelib;
#[cfg(test)]
#[macro_use]
extern crate doc_comment;
#[cfg(test)]
doctest!("../README.md");
// this reexport is to aid the transition and should not be in the prelude! // this reexport is to aid the transition and should not be in the prelude!
pub use oldtime::Duration; pub use oldtime::Duration;