From 3983924d4f180d419e34f52bd5343bf8fc5a70c9 Mon Sep 17 00:00:00 2001 From: Elizabeth Engelman <4752801+elizabethengelman@users.noreply.github.com> Date: Thu, 7 Dec 2023 10:49:30 -0500 Subject: [PATCH] A few tweaks to doc comments --- cmd/soroban-cli/src/commands/network/start.rs | 2 +- cmd/soroban-cli/src/commands/network/stop.rs | 2 +- docs/soroban-cli-full-docs.md | 4 ++-- 3 files changed, 4 insertions(+), 4 deletions(-) diff --git a/cmd/soroban-cli/src/commands/network/start.rs b/cmd/soroban-cli/src/commands/network/start.rs index 58da5631cd..cc0abd1ec4 100644 --- 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 index 1a37168298..331f8dbe0d 100644 --- 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, } diff --git a/docs/soroban-cli-full-docs.md b/docs/soroban-cli-full-docs.md index 7e599f4fb3..67be2c3582 100644 --- a/docs/soroban-cli-full-docs.md +++ b/docs/soroban-cli-full-docs.md @@ -852,7 +852,7 @@ Start network ###### **Arguments:** -* `` — Network to start +* `` — Network to start, e.g. local, testnet, futurenet ###### **Options:** @@ -877,7 +877,7 @@ Stop network ###### **Arguments:** -* `` — docker container to stop +* `` — docker container to stop, defaults to "stellar"