Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

update docs #110

Merged
merged 2 commits into from
Nov 29, 2024
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
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 plan 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