Enhance documentation with usage examples for date generation utilities

This commit is contained in:
Palash Tyagi
2025-08-03 16:45:15 +01:00
parent 18b9eef063
commit f7325a9558
3 changed files with 28 additions and 0 deletions

View File

@@ -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};