Fix yard warnings in list.rb and multi_list.rb

piotrmurach · Aug 21, 2021 · 7dc89e8 · 7dc89e8
1 parent 9dea17b
commit 7dc89e8
Show file tree

Hide file tree

Showing 2 changed files with 10 additions and 10 deletions.
diff --git a/lib/tty/prompt/list.rb b/lib/tty/prompt/list.rb
@@ -30,7 +30,7 @@ class List
 
       # Create instance of TTY::Prompt::List menu.
       #
-      # @param Hash options
+      # @param [Hash] options
       #   the configuration options
       # @option options [Symbol] :default
       #   the default active choice, defaults to 1
@@ -111,7 +111,7 @@ def confirm_keys(*keys)
       # Initialize any default or custom action keys
       # setting up their labels and dealing with compat
       #
-      # @param [Array<Symbol, String, Hash{Symbol, String => String}>]
+      # @param [Array<Symbol, String, Hash{Symbol, String => String}>] keys
       #
       # @return [Hash{Symbol, String => String}]
       #
@@ -134,9 +134,9 @@ def init_action_keys(keys)
       #   keys_with_labels(keys)
       #   # => {enter: "Enter", ctrl_s: "Ctrl-S"}
       #
-      # @param [Array<Symbol, String, Hash{Symbol, String => String}>]
+      # @param [Array<Symbol, String, Hash{Symbol, String => String}>] keys
       #
-      # @return [String]
+      # @return [Hash{Symbol, String => String}]
       #
       # @api private
       def keys_with_labels(keys)
@@ -148,7 +148,7 @@ def keys_with_labels(keys)
 
       # Convert a key name into a human-readable label
       #
-      # @param [Symbol, String]
+      # @param [Symbol, String] key_name
       #
       # @return [String]
       #
@@ -170,7 +170,7 @@ def key_help_label(key_name)
       #   ensure_eol_compat(keys)
       #   # => {enter: "Enter", return: "Enter", ctrl_s: "Ctrl+S"}
       #
-      # @param [Hash{Symbol, String => String}]
+      # @param [Hash{Symbol, String => String}] keys
       #
       # @return [Hash{Symbol, String => String}]
       #
@@ -284,7 +284,7 @@ def arrows_help
       #   keys_help(keys)
       #   # => "Enter"
       #
-      # @param [Hash{Symbol, String => String}]
+      # @param [Hash{Symbol, String => String}] keys
       #
       # @return [String]
       #
@@ -368,8 +368,8 @@ def choices(values = (not_set = true))
       # Call the list menu by passing question and choices
       #
       # @param [String] question
+      # @param [Array[Object]] possibilities
       #
-      # @param
       # @api public
       def call(question, possibilities, &block)
         choices(possibilities)
@@ -625,7 +625,7 @@ def answer
 
       # Clear screen lines
       #
-      # @param [String]
+      # @param [Integer] lines
       #
       # @api private
       def refresh(lines)

diff --git a/lib/tty/prompt/multi_list.rb b/lib/tty/prompt/multi_list.rb
@@ -18,7 +18,7 @@ class MultiList < List
 
       # Create instance of TTY::Prompt::MultiList menu.
       #
-      # @param [Prompt] :prompt
+      # @param [Prompt] prompt
       # @param [Hash] options
       # @option options [Array<Symbol, String, Hash{Symbol, String => String}>]
       #   :select_keys the key(s) used for selecting choices