Do not show hidden arguments

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

Hide file tree

Showing 2 changed files with 9 additions and 2 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,8 +377,10 @@ fn build_command_markdown(
 }
 
 fn write_arg_markdown(buffer: &mut String, arg: &clap::Arg) -> fmt::Result {
-    // Markdown list item
-    write!(buffer, "* ")?;
+    // Don't print docs for hidden args
+    if arg.is_hide_set() {
+        return Ok(());
+    }
 
     let value_name: String = match arg.get_value_names() {
         // TODO: What if multiple names are provided?
@@ -389,6 +391,8 @@ fn write_arg_markdown(buffer: &mut String, arg: &clap::Arg) -> fmt::Result {
         None => arg.get_id().to_string().to_ascii_uppercase(),
     };
 
+    // Markdown list item
+    write!(buffer, "* ")?;
     match (arg.get_short(), arg.get_long()) {
         (Some(short), Some(long)) => {
             if arg.get_action().takes_values() {