Skip to content
This repository was archived by the owner on Nov 15, 2023. It is now read-only.
Merged
Prev Previous commit
Next Next commit
improve comments
  • Loading branch information
liamaharon committed Aug 3, 2023
commit fe8dd35b2b8deae436bf4b083d8c1d495eea0531
9 changes: 5 additions & 4 deletions test-utils/cli/src/lib.rs
Original file line number Diff line number Diff line change
Expand Up @@ -36,12 +36,13 @@ use std::{
use tokio::io::{AsyncBufReadExt, AsyncRead};

/// Similar to [`crate::start_node`] spawns a dev node on port `45789`, but works in environments
/// where you can't access the substarte binary using `cargo_bin("substrate-node")`.
/// where the substarte binary is not accessible with `cargo_bin("substrate-node")`.
///
/// Helpful when you need a Substrate node running in the background in an external project.
/// Helpful if you need a Substrate dev node running in the background of a project external to
/// `substrate`.
///
/// The downside compared to [`crate::start_node`] is that this function is blocking and has no way
/// of returning a [`Child`]. So you may want to start it inside a new thread.
/// The downside compared to using [`crate::start_node`] is that this method is blocking rather than
/// returning a [`Child`]. Therefore, you may want to call this method inside a new thread.
///
/// # Example
/// ```ignore
Expand Down