docs(rust): update relay list documentation

build-trust · Oct 10, 2023 · 01f9385 · 01f9385
1 parent 7c689b1
commit 01f9385
Show file tree

Hide file tree

Showing 3 changed files with 5 additions and 2 deletions.
diff --git a/implementations/rust/ockam/ockam_command/src/relay/list.rs b/implementations/rust/ockam/ockam_command/src/relay/list.rs
@@ -18,17 +18,19 @@ use crate::util::node_rpc;
 use crate::{docs, CommandGlobalOpts};
 
 const PREVIEW_TAG: &str = include_str!("../static/preview_tag.txt");
+const LONG_ABOUT: &str = include_str!("./static/list/long_about.txt");
 const AFTER_LONG_HELP: &str = include_str!("./static/list/after_long_help.txt");
 
 /// List Relays
 #[derive(Clone, Debug, Args)]
 #[command(
     arg_required_else_help = false,
     before_help = docs::before_help(PREVIEW_TAG),
+    long_about = docs::about(LONG_ABOUT),
     after_long_help = docs::after_help(AFTER_LONG_HELP)
 )]
 pub struct ListCommand {
-    ///  List all the relays relaying traffic to the specified node
+    /// Get the list of Relays at the given node
     #[arg(global = true, long, value_name = "NODE")]
     pub to: Option<String>,
 }

diff --git a/implementations/rust/ockam/ockam_command/src/relay/static/list/after_long_help.txt b/implementations/rust/ockam/ockam_command/src/relay/static/list/after_long_help.txt
@@ -1,3 +1,3 @@
 ```sh
-$ ockam relay list --at n2
+$ ockam relay list --to n2
 ```
diff --git a/implementations/rust/ockam/ockam_command/src/relay/static/list/long_about.txt b/implementations/rust/ockam/ockam_command/src/relay/static/list/long_about.txt
@@ -0,0 +1 @@
+List Relays on your default node. If you pass '--to <NODE>' then it lists the Relays at the given node.
Original file line number	Diff line number	Diff line change
		@@ -0,0 +1 @@
		List Relays on your default node. If you pass '--to <NODE>' then it lists the Relays at the given node.