A few tweaks to doc comments

stellar · Jan 5, 2024 · 1ab08a7 · 1ab08a7
1 parent a37e942
commit 1ab08a7
Show file tree

Hide file tree

Showing 3 changed files with 4 additions and 4 deletions.
diff --git a/cmd/soroban-cli/src/commands/network/start.rs b/cmd/soroban-cli/src/commands/network/start.rs
@@ -11,7 +11,7 @@ const DOCKER_TAG: &str = "testing";
 
 #[derive(Debug, clap::Parser, Clone)]
 pub struct Cmd {
-    /// Network to start
+    /// Network to start, e.g. local, testnet, futurenet
     pub network: String,
 
     /// optional argument to customize container name

diff --git a/cmd/soroban-cli/src/commands/network/stop.rs b/cmd/soroban-cli/src/commands/network/stop.rs
@@ -13,7 +13,7 @@ const CONTAINER_NAME: &str = "stellar";
 
 #[derive(Debug, clap::Parser, Clone)]
 pub struct Cmd {
-    /// docker container to stop
+    /// docker container to stop, defaults to "stellar"
     pub container: Option<String>,
 }
 

diff --git a/docs/soroban-cli-full-docs.md b/docs/soroban-cli-full-docs.md
@@ -1301,7 +1301,7 @@ Start network
 
 ###### **Arguments:**
 
-* `<NETWORK>` — Network to start
+* `<NETWORK>` — Network to start, e.g. local, testnet, futurenet
 
 ###### **Options:**
 
@@ -1326,7 +1326,7 @@ Stop network
 
 ###### **Arguments:**
 
-* `<CONTAINER>` — docker container to stop
+* `<CONTAINER>` — docker container to stop, defaults to "stellar"