more documentation, finishing examples for chrono::naive::date.

Author: lifthrasiir

src/date.rs

@@ -231,7 +231,8 @@ impl<Tz: TimeZone> Date<Tz> where Tz::Offset: fmt::Display {
     }
 
     /// Formats the date with the specified format string.
-    /// See the `format::strftime` module on the supported escape sequences.
+    /// See the [`format::strftime` module](../format/strftime/index.html)
+    /// on the supported escape sequences.
     #[inline]
     pub fn format<'a>(&self, fmt: &'a str) -> DelayedFormat<StrftimeItems<'a>> {
         self.format_with_items(StrftimeItems::new(fmt))

src/datetime.rs

@@ -146,7 +146,8 @@ impl DateTime<FixedOffset> {
 
     /// Parses a string with the specified format string and
     /// returns a new `DateTime` with a parsed `FixedOffset`.
-    /// See the `format::strftime` module on the supported escape sequences.
+    /// See the [`format::strftime` module](../format/strftime/index.html)
+    /// on the supported escape sequences.
     ///
     /// See also `Offset::datetime_from_str` which gives a local `DateTime` on specific time zone.
     pub fn parse_from_str(s: &str, fmt: &str) -> ParseResult<DateTime<FixedOffset>> {
@@ -178,7 +179,8 @@ impl<Tz: TimeZone> DateTime<Tz> where Tz::Offset: fmt::Display {
     }
 
     /// Formats the combined date and time with the specified format string.
-    /// See the `format::strftime` module on the supported escape sequences.
+    /// See the [`format::strftime` module](../format/strftime/index.html)
+    /// on the supported escape sequences.
     #[inline]
     pub fn format<'a>(&self, fmt: &'a str) -> DelayedFormat<StrftimeItems<'a>> {
         self.format_with_items(StrftimeItems::new(fmt))

src/lib.rs

@@ -424,6 +424,9 @@ impl Weekday {
     }
 }
 
+/// Any weekday can be represented as an integer from 0 to 6,
+/// which equals to `Weekday::num_days_from_monday` in this implementation.
+/// Do not heavily depend on this though; use explicit methods whenever possible.
 impl num::traits::FromPrimitive for Weekday {
 
     #[inline]

src/naive/date.rs

@@ -75,7 +75,8 @@ impl NaiveDateTime {
     }
 
     /// Parses a string with the specified format string and returns a new `NaiveDateTime`.
-    /// See the `format::strftime` module on the supported escape sequences.
+    /// See the [`format::strftime` module](../../format/strftime/index.html)
+    /// on the supported escape sequences.
     pub fn parse_from_str(s: &str, fmt: &str) -> ParseResult<NaiveDateTime> {
         let mut parsed = Parsed::new();
         try!(parse(&mut parsed, s, StrftimeItems::new(fmt)));
@@ -162,7 +163,8 @@ impl NaiveDateTime {
     }
 
     /// Formats the combined date and time with the specified format string.
-    /// See the `format::strftime` module on the supported escape sequences.
+    /// See the [`format::strftime` module](../../format/strftime/index.html)
+    /// on the supported escape sequences.
     #[inline]
     pub fn format<'a>(&self, fmt: &'a str) -> DelayedFormat<StrftimeItems<'a>> {
         self.format_with_items(StrftimeItems::new(fmt))

src/naive/datetime.rs

@@ -119,7 +119,8 @@ impl NaiveTime {
     }
 
     /// Parses a string with the specified format string and returns a new `NaiveTime`.
-    /// See the `format::strftime` module on the supported escape sequences.
+    /// See the [`format::strftime` module](../../format/strftime/index.html)
+    /// on the supported escape sequences.
     pub fn parse_from_str(s: &str, fmt: &str) -> ParseResult<NaiveTime> {
         let mut parsed = Parsed::new();
         try!(parse(&mut parsed, s, StrftimeItems::new(fmt)));
@@ -134,7 +135,8 @@ impl NaiveTime {
     }
 
     /// Formats the time with the specified format string.
-    /// See the `format::strftime` module on the supported escape sequences.
+    /// See the [`format::strftime` module](../../format/strftime/index.html)
+    /// on the supported escape sequences.
     #[inline]
     pub fn format<'a>(&self, fmt: &'a str) -> DelayedFormat<StrftimeItems<'a>> {
         self.format_with_items(StrftimeItems::new(fmt))

src/naive/time.rs

@@ -272,7 +272,8 @@ pub trait TimeZone: Sized + Clone {
 
     /// Parses a string with the specified format string and
     /// returns a `DateTime` with the current offset.
-    /// See the `format::strftime` module on the supported escape sequences.
+    /// See the [`format::strftime` module](../../format/strftime/index.html)
+    /// on the supported escape sequences.
     ///
     /// If the format does not include offsets, the current offset is assumed;
     /// otherwise the input should have a matching UTC offset.