Merge pull request #210 from dividedmind/full-synopsis-required-options

Don't mark required options with brackets in full synopsis
davetron5000 · Feb 21, 2015 · 3b7c467 · 3b7c467
2 parents 73a9e15 + 716f6e3
commit 3b7c467
Show file tree

Hide file tree

Showing 2 changed files with 7 additions and 2 deletions.
diff --git a/lib/gli/commands/help_modules/full_synopsis_formatter.rb b/lib/gli/commands/help_modules/full_synopsis_formatter.rb
@@ -27,10 +27,11 @@ def synopses_for_command(command)
 
         def sub_options_doc(sub_options)
           sub_options_doc = sub_options.map { |_,option| 
-            option.names_and_aliases.map { |name| 
+            doc = option.names_and_aliases.map { |name|
               CommandLineOption.name_as_string(name,false) + (option.kind_of?(Flag) ? " #{option.argument_name }" : '')
             }.join('|')
-          }.map { |invocations| "[#{invocations}]" }.sort.join(' ').strip
+            option.required?? doc : "[#{doc}]"
+          }.sort.join(' ').strip
         end
 
       private

diff --git a/lib/gli/switch.rb b/lib/gli/switch.rb
@@ -31,5 +31,9 @@ def arguments_for_option_parser
     def negatable?
       @negatable
     end
+
+    def required?
+      false
+    end
   end
 end