fix: rename omit_usage to hidden_help

Author: aminya

argh/src/lib.rs

@@ -294,7 +294,7 @@
 //! Programs that are run from an environment such as cargo may find it
 //! useful to have positional arguments present in the structure but
 //! omitted from the usage output. This can be accomplished by adding
-//! the `omit_usage` attribute to that argument:
+//! the `hidden_help` attribute to that argument:
 //!
 //! ```rust
 //! # use argh::FromArgs;
@@ -304,10 +304,10 @@
 //! struct CargoArgs {
 //!     // Cargo puts the command name invoked into the first argument,
 //!     // so we don't want this argument to show up in the usage text.
-//!     #[argh(positional, omit_usage)]
+//!     #[argh(positional, hidden_help)]
 //!     command: String,
 //!     /// An option used for internal debugging
-//!     #[argh(option, omit_usage)]
+//!     #[argh(option, hidden_help)]
 //!     internal_debugging: String
 //!     #[argh(positional)]
 //!     real_first_arg: String,

argh/tests/lib.rs

@@ -1175,18 +1175,18 @@ Options:
     }
 
     #[test]
-    fn omit_usage_attribute() {
+    fn hidden_help_attribute() {
         #[derive(FromArgs)]
         /// Short description
         struct Cmd {
             /// this one should be hidden
-            #[argh(positional, omit_usage)]
+            #[argh(positional, hidden_help)]
             _one: String,
             #[argh(positional)]
             /// this one is real
             _two: String,
             /// this one should be hidden
-            #[argh(option, omit_usage)]
+            #[argh(option, hidden_help)]
             _three: String,
         }
 

argh_derive/src/help.rs

@@ -31,7 +31,7 @@ pub(crate) fn help(
     let mut format_lit = "Usage: {command_name}".to_string();
 
     let positional = fields.iter().filter(|f| {
-        f.kind == FieldKind::Positional && f.attrs.greedy.is_none() && !f.attrs.omit_usage
+        f.kind == FieldKind::Positional && f.attrs.greedy.is_none() && !f.attrs.hidden_help
     });
     let mut has_positional = false;
     for arg in positional.clone() {
@@ -40,14 +40,14 @@ pub(crate) fn help(
         positional_usage(&mut format_lit, arg);
     }
 
-    let options = fields.iter().filter(|f| f.long_name.is_some() && !f.attrs.omit_usage);
+    let options = fields.iter().filter(|f| f.long_name.is_some() && !f.attrs.hidden_help);
     for option in options.clone() {
         format_lit.push(' ');
         option_usage(&mut format_lit, option);
     }
 
     let remain = fields.iter().filter(|f| {
-        f.kind == FieldKind::Positional && f.attrs.greedy.is_some() && !f.attrs.omit_usage
+        f.kind == FieldKind::Positional && f.attrs.greedy.is_some() && !f.attrs.hidden_help
     });
     for arg in remain {
         format_lit.push(' ');

argh_derive/src/parse_attrs.rs

@@ -19,7 +19,7 @@ pub struct FieldAttrs {
     pub short: Option<syn::LitChar>,
     pub arg_name: Option<syn::LitStr>,
     pub greedy: Option<syn::Path>,
-    pub omit_usage: bool,
+    pub hidden_help: bool,
 }
 
 /// The purpose of a particular field on a `#![derive(FromArgs)]` struct.
@@ -124,15 +124,15 @@ impl FieldAttrs {
                     );
                 } else if name.is_ident("greedy") {
                     this.greedy = Some(name.clone());
-                } else if name.is_ident("omit_usage") {
-                    this.omit_usage = true;
+                } else if name.is_ident("hidden_help") {
+                    this.hidden_help = true;
                 } else {
                     errors.err(
                         &meta,
                         concat!(
                             "Invalid field-level `argh` attribute\n",
                             "Expected one of: `arg_name`, `default`, `description`, `from_str_fn`, `greedy`, ",
-                            "`long`, `option`, `short`, `subcommand`, `switch`, `omit_usage`",
+                            "`long`, `option`, `short`, `subcommand`, `switch`, `hidden_help`",
                         ),
                     );
                 }