Skip to content

Commit

Permalink
update docs
Browse files Browse the repository at this point in the history
  • Loading branch information
ChiragKumar9 committed Nov 29, 2024
1 parent c957f89 commit f2a234a
Show file tree
Hide file tree
Showing 2 changed files with 3 additions and 5 deletions.
4 changes: 1 addition & 3 deletions src/context.rs
Original file line number Diff line number Diff line change
Expand Up @@ -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,
Expand Down
4 changes: 2 additions & 2 deletions src/report.rs
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand Down Expand Up @@ -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));
}
}
Expand Down

0 comments on commit f2a234a

Please sign in to comment.