From 2b38f08550e03cddf623185e3baa1820b009ff34 Mon Sep 17 00:00:00 2001
From: Michael Aaron Murphy <mmstick@pm.me>
Date: Tue, 12 Apr 2022 13:34:43 +0200
Subject: [PATCH] chore: Add missing public types in documentation

---
 src/error.rs    | 3 +++
 src/lib.rs      | 4 +++-
 src/schedule.rs | 4 +++-
 3 files changed, 9 insertions(+), 2 deletions(-)

diff --git a/src/error.rs b/src/error.rs
index be154fa..e34fc36 100644
--- a/src/error.rs
+++ b/src/error.rs
@@ -1,12 +1,15 @@
 use std::{error, fmt};
 
+/// A cron error
 #[derive(Debug)]
 pub struct Error {
     kind: ErrorKind,
 }
 
+/// The kind of cron error that occurred
 #[derive(Debug)]
 pub enum ErrorKind {
+    /// Failed to parse an expression
     Expression(String),
 }
 
diff --git a/src/lib.rs b/src/lib.rs
index 311b24e..b6a65c7 100644
--- a/src/lib.rs
+++ b/src/lib.rs
@@ -34,7 +34,9 @@
 //! */
 //! ```
 
+/// Error types used by this crate.
 pub mod error;
+
 mod schedule;
 mod time_unit;
 mod ordinal;
@@ -42,5 +44,5 @@ mod specifier;
 mod queries;
 mod parsing;
 
-pub use crate::schedule::Schedule;
+pub use crate::schedule::{Schedule, ScheduleIterator};
 pub use crate::time_unit::TimeUnitSpec;
diff --git a/src/schedule.rs b/src/schedule.rs
index 4738f4c..f252200 100644
--- a/src/schedule.rs
+++ b/src/schedule.rs
@@ -14,6 +14,7 @@ impl From<Schedule> for String {
     }
 }
 
+/// Representation of a cron expression
 #[derive(Clone, Debug, Eq)]
 pub struct Schedule {
     source: String,
@@ -332,6 +333,7 @@ impl ScheduleFields {
     }
 }
 
+/// Iterates `DateTime` occurrences of a schedule.
 pub struct ScheduleIterator<'a, Z>
 where
     Z: TimeZone,
@@ -563,7 +565,7 @@ mod test {
         let prev = schedule.after(&dt).rev().next().unwrap();
         assert!(prev < dt); // test is ensuring line above does not panic
     }
-    
+
     #[test]
     fn test_time_unit_spec_equality() {
         let schedule_1 = Schedule::from_str("@weekly").unwrap();