diff --git a/core/src/environment/mod.rs b/core/src/environment/mod.rs index fdb64def..41096131 100644 --- a/core/src/environment/mod.rs +++ b/core/src/environment/mod.rs @@ -14,8 +14,7 @@ //! - [`EnvironmentParameters`]: Parameters necessary for creating or modifying //! an [`Environment`]. //! - [`Instruction`]: Enum indicating the type of instruction that is being -//! sent -//! to the EVM. +//! sent to the EVM. use std::thread::{self, JoinHandle}; @@ -62,8 +61,8 @@ pub(crate) type OutcomeReceiver = Receiver>; /// [`Socket`] provide the [`Environment`] a means to route and execute /// transactions. /// * [`ArbiterDB`] is the database structure used that allows for read-only -/// sharing of execution and write-only via the main thread. This can also be a -/// database read in from disk storage via [`database::fork::Fork`]. +/// sharing of execution and write-only via the main thread. This can also be +/// a database read in from disk storage via [`database::fork::Fork`]. /// * [`ArbiterInspector`] is an that allows for the EVM to be able to display /// logs and properly handle gas payments. /// * [`EnvironmentParameters`] are used to set the gas limit, contract size @@ -694,8 +693,7 @@ pub enum Broadcast { /// than 2^64 # Arguments /// * `input` - The U256 to convert. /// # Returns -/// * `Ok(U64)` - The converted U64. -/// Used for block number which is a U64. +/// * `Ok(U64)` - The converted U64. Used for block number which is a U64. #[inline] fn convert_uint_to_u64(input: U256) -> Result { let as_str = input.to_string(); diff --git a/engine/src/agent.rs b/engine/src/agent.rs index 8a6c921e..756db8d6 100644 --- a/engine/src/agent.rs +++ b/engine/src/agent.rs @@ -102,9 +102,8 @@ impl AgentBuilder { /// # Parameters /// /// - `engine`: The state machine engine to be added to the agent builder. - /// This engine must - /// implement the `StateMachine` trait and is expected to be provided as a - /// boxed trait object to allow for dynamic dispatch. + /// This engine must implement the `StateMachine` trait and is expected to + /// be provided as a boxed trait object to allow for dynamic dispatch. /// /// # Returns /// diff --git a/engine/src/world.rs b/engine/src/world.rs index 272ad1fe..e84ed9a7 100644 --- a/engine/src/world.rs +++ b/engine/src/world.rs @@ -63,15 +63,13 @@ impl World { /// # Type Parameters /// /// - `C`: The type of the behavior component that each agent will be - /// associated with. - /// This type must implement the `CreateStateMachine`, `Serialize`, - /// `DeserializeOwned`, and `Debug` traits. + /// associated with. This type must implement the `CreateStateMachine`, + /// `Serialize`, `DeserializeOwned`, and `Debug` traits. /// /// # Arguments /// /// - `config_path`: A string slice that holds the path to the configuration - /// file - /// relative to the current working directory. + /// file relative to the current working directory. /// /// # Panics /// @@ -80,8 +78,7 @@ impl World { /// - The configuration file specified by `config_path` cannot be opened. /// - The configuration file cannot be read into a string. /// - The contents of the configuration file cannot be deserialized into the - /// expected - /// `HashMap>` format. + /// expected `HashMap>` format. /// /// # Examples ///