Skip to content

Commit

Permalink
minor tweaks
Browse files Browse the repository at this point in the history
  • Loading branch information
calbaker committed Feb 6, 2024
1 parent 7960663 commit 4fb10f3
Showing 1 changed file with 3 additions and 4 deletions.
7 changes: 3 additions & 4 deletions rust/fastsim-core/src/traits.rs
Original file line number Diff line number Diff line change
Expand Up @@ -188,8 +188,7 @@ pub trait SerdeAPI: Serialize + for<'a> Deserialize<'a> {
Ok(bincode_de)
}

/// instantiates an object from a url
/// accepts yaml and json file types
/// Instantiates an object from a url. Accepts yaml and json file types
/// # Arguments
/// - url: URL (either as a string or url type) to object
/// Note: The URL needs to be a URL pointing directly to a file, for example
Expand All @@ -206,8 +205,8 @@ pub trait SerdeAPI: Serialize + for<'a> Deserialize<'a> {
Self::from_reader(response, format)
}

/// takes an instantiated Rust object and saves it in the FASTSim data directory in
/// a rust_objects folder
/// Takes an instantiated Rust object and saves it in the FASTSim data directory in
/// a rust_objects folder.
/// WARNING: If there is a file already in the data subdirectory with the
/// same name, it will be replaced by the new file.
/// # Arguments
Expand Down

0 comments on commit 4fb10f3

Please sign in to comment.