diff --git a/src/utils/dateutils/dates.rs b/src/utils/dateutils/dates.rs index 2fa6f7f..a5b3481 100644 --- a/src/utils/dateutils/dates.rs +++ b/src/utils/dateutils/dates.rs @@ -1,3 +1,10 @@ +//! Generation and manipulation of calendar date sequences. +//! +//! ``` +//! use rustframe::utils::dateutils::dates::{DateFreq, DatesList}; +//! let list = DatesList::new("2024-01-01".into(), "2024-01-03".into(), DateFreq::Daily); +//! assert_eq!(list.count().unwrap(), 3); +//! ``` use chrono::{Datelike, Duration, NaiveDate, Weekday}; use std::collections::HashMap; use std::error::Error; diff --git a/src/utils/dateutils/mod.rs b/src/utils/dateutils/mod.rs index 53ea47c..237d8e0 100644 --- a/src/utils/dateutils/mod.rs +++ b/src/utils/dateutils/mod.rs @@ -1,3 +1,13 @@ +//! Generators for sequences of calendar and business dates. +//! +//! See [`dates`] for all-day calendars and [`bdates`] for business-day aware +//! variants. +//! +//! ``` +//! use rustframe::utils::dateutils::{DatesList, DateFreq}; +//! let list = DatesList::new("2024-01-01".into(), "2024-01-02".into(), DateFreq::Daily); +//! assert_eq!(list.count().unwrap(), 2); +//! ``` pub mod bdates; pub mod dates; diff --git a/src/utils/mod.rs b/src/utils/mod.rs index e00de87..ef448cc 100644 --- a/src/utils/mod.rs +++ b/src/utils/mod.rs @@ -1,3 +1,14 @@ +//! Assorted helper utilities. +//! +//! Currently this module exposes date generation utilities in [`dateutils`](crate::utils::dateutils), +//! including calendar and business date sequences. +//! +//! ``` +//! use rustframe::utils::DatesList; +//! use rustframe::utils::DateFreq; +//! let dates = DatesList::new("2024-01-01".into(), "2024-01-03".into(), DateFreq::Daily); +//! assert_eq!(dates.count().unwrap(), 3); +//! ``` pub mod dateutils; pub use dateutils::{BDateFreq, BDatesGenerator, BDatesList};