Do not show hidden arguments

Fixes ConnorGray#18
ilyagr · Jun 13, 2024 · 8ef59d9 · 8ef59d9
1 parent d3985a3
commit 8ef59d9
Show file tree

Hide file tree

Showing 2 changed files with 7 additions and 0 deletions.
diff --git a/docs/examples/complex_app.rs b/docs/examples/complex_app.rs
@@ -20,6 +20,9 @@ pub struct Cli {
     #[arg(short, long, action = clap::ArgAction::Count)]
     debug: u8,
 
+    #[arg(short, long, hide = true)]
+    secret_arg: bool,
+
     #[command(subcommand)]
     command: Option<Commands>,
 }

diff --git a/src/lib.rs b/src/lib.rs
@@ -377,6 +377,10 @@ fn build_command_markdown(
 }
 
 fn write_arg_markdown(buffer: &mut String, arg: &clap::Arg) -> fmt::Result {
+    // Don't print docs for hidden args
+    if arg.is_hide_set() {
+        return Ok(());
+    }
     // Markdown list item
     write!(buffer, "* ")?;