Skip to content

Commit

Permalink
docs: improve function docs
Browse files Browse the repository at this point in the history
  • Loading branch information
al3mart committed Dec 18, 2024
1 parent 5a3b977 commit 19e7084
Showing 1 changed file with 5 additions and 0 deletions.
5 changes: 5 additions & 0 deletions crates/pop-cli/src/common/contracts.rs
Original file line number Diff line number Diff line change
Expand Up @@ -14,6 +14,8 @@ use tempfile::NamedTempFile;
/// prompts the user to update it if the existing binary is not the latest version.
///
/// # Arguments
/// * `cli`: Command line interface.
/// * `cache_path`: The cache directory path.
/// * `skip_confirm`: A boolean indicating whether to skip confirmation prompts.
pub async fn check_contracts_node_and_prompt(
cli: &mut impl Cli,
Expand Down Expand Up @@ -78,6 +80,9 @@ pub async fn check_contracts_node_and_prompt(
}

/// Handles the optional termination of a local running node.
/// # Arguments
/// * `cli`: Command line interface.
/// * `process`: Tuple identifying the child process to terminate and its log file.
pub fn terminate_node(
cli: &mut impl Cli,
process: Option<(Child, NamedTempFile)>,
Expand Down

0 comments on commit 19e7084

Please sign in to comment.