From f2a234a1ae2c8560bfd4fc3a75b2e5003afa7548 Mon Sep 17 00:00:00 2001
From: Chirag Kumar <kzs9@cdc.gov>
Date: Fri, 29 Nov 2024 20:50:42 +0000
Subject: [PATCH] update docs

---
 src/context.rs | 4 +---
 src/report.rs  | 4 ++--
 2 files changed, 3 insertions(+), 5 deletions(-)

diff --git a/src/context.rs b/src/context.rs
index 61a7251a..0e90a19d 100644
--- a/src/context.rs
+++ b/src/context.rs
@@ -179,11 +179,9 @@ impl Context {
     /// continuously repeat the plan at the specified period, stopping
     /// only once there are no other plans scheduled.
     ///
-    /// Returns an `Id` for the newly-added plan that can be used to cancel it
-    /// if needed.
     /// # Panics
     ///
-    /// Panics if time is negative, infinite, or NaN.
+    /// Panics if report period is negative, infinite, or NaN.
     pub fn add_periodic_plan_with_phase(
         &mut self,
         period: f64,
diff --git a/src/report.rs b/src/report.rs
index 350f15cc..15d4c00f 100644
--- a/src/report.rs
+++ b/src/report.rs
@@ -40,7 +40,7 @@ impl ConfigReportOptions {
         self.directory = directory;
         self
     }
-    /// Sets the overwrite option
+    /// Sets whether to overwrite existing reports of the same name if they exist
     pub fn overwrite(&mut self, overwrite: bool) -> &mut ConfigReportOptions {
         self.overwrite = overwrite;
         self
@@ -136,7 +136,7 @@ impl ContextReportExt for Context {
                     if data_container.config.overwrite {
                         File::create(&path)?
                     } else {
-                        println!("File already exists: {}. Please rerun setting overwrite to true in the file config.", path.display());
+                        println!("File already exists: {}. Please set `overwrite` to true in the file configuration and rerun.", path.display());
                         return Err(IxaError::IoError(e));
                     }
                 }