From b63601debb9825fb64ff8dd471bab7d9fc2f98bf Mon Sep 17 00:00:00 2001 From: Paul Dicker Date: Thu, 20 Jul 2023 16:55:35 +0200 Subject: [PATCH] Add example to `Weekday::num_days_from_monday` --- src/weekday.rs | 13 +++++++++++++ 1 file changed, 13 insertions(+) diff --git a/src/weekday.rs b/src/weekday.rs index f51e2178..a7abd941 100644 --- a/src/weekday.rs +++ b/src/weekday.rs @@ -114,6 +114,19 @@ impl Weekday { /// `w`: | `Mon` | `Tue` | `Wed` | `Thu` | `Fri` | `Sat` | `Sun` /// --------------------------- | ----- | ----- | ----- | ----- | ----- | ----- | ----- /// `w.num_days_from_monday()`: | 0 | 1 | 2 | 3 | 4 | 5 | 6 + /// + /// # Example + /// + #[cfg_attr(not(feature = "clock"), doc = "```ignore")] + #[cfg_attr(feature = "clock", doc = "```rust")] + /// # use chrono::{Local, Datelike}; + /// // MTWRFSU is occasionally used as a single-letter abbreviation of the weekdays. + /// // Use `num_days_from_monday` to index into the array. + /// const MTWRFSU: [char; 7] = ['M', 'T', 'W', 'R', 'F', 'S', 'U']; + /// + /// let today = Local::now().weekday(); + /// println!("{}", MTWRFSU[today.num_days_from_monday() as usize]); + /// ``` #[inline] pub const fn num_days_from_monday(&self) -> u32 { self.num_days_from(Weekday::Mon)