summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorAbinoam Praxedes Marques Jr <abinoam@gmail.com>2015-12-13 16:32:41 -0300
committerAbinoam Praxedes Marques Jr <abinoam@gmail.com>2015-12-13 16:32:54 -0300
commita687cc2af40b09715f69f5fc94728a83b4ebd394 (patch)
tree7acef4e3a379245b0bcc00229dd0c526a3da97cf
parente85d4c082fa49851062fe163eaffe56dd08fe217 (diff)
downloadhighline-a687cc2af40b09715f69f5fc94728a83b4ebd394.tar.gz
Improve HighLine::Menu#choices documentation
-rw-r--r--lib/highline/menu.rb7
1 files changed, 5 insertions, 2 deletions
diff --git a/lib/highline/menu.rb b/lib/highline/menu.rb
index 7ef2ab6..15695c5 100644
--- a/lib/highline/menu.rb
+++ b/lib/highline/menu.rb
@@ -169,11 +169,14 @@ class HighLine
end
#
- # A shortcut for multiple calls to the sister method choice(). <b>Be
+ # A shortcut for multiple calls to the sister method {#choice}. <b>Be
# warned:</b> An _action_ set here will apply to *all* provided
# _names_. This is considered to be a feature, so you can easily
# hand-off interface processing to a different chunk of code.
- #
+ # @param names [Array<#to_s>] menu item titles/headers/names to be displayed.
+ # @param action (see #choice)
+ # @return [void]
+ # @example (see HighLine::Menu#initialize)
def choices( *names, &action )
names.each { |n| choice(n, &action) }
end