lib/faker/bot/commands/list.rb in faker-bot-0.5.0 vs lib/faker/bot/commands/list.rb in faker-bot-0.5.1

@@ -4,23 +4,51 @@
 require_relative '../reflectors/list'
 
 module Faker
   module Bot
     module Commands
+      # Lists all [Faker<Base>] constants
+      #
+      # @api private
+      #
       class List < Command
+        # Execute the `list` command
+        #
+        # @return [IO]
+        #
+        # @api private
+        #
         def execute(output: $stdout)
           result = Reflectors::List.call(options)
           render(result, output)
         end
 
         private
 
+        # Render the search results
+        #  * Return #not_found when there're no matching results
+        #
+        # @param result [Hash] the render tree
+        # @param output [IO]
+        #
+        # @return [IO]
+        #
+        # @api private
+        #
         def render(result, output)
           return not_found(output) if result.empty?
 
           super(result, output)
         end
 
+        # Render a bespoke "not found" message
+        #
+        # @param output [IO]
+        #
+        # @return [IO]
+        #
+        # @api private
+        #
         def not_found(output)
           output.puts "\nSorry, that class doesn't exist 😢", "\n",
                       'Try something like `Faker::Beer` or `Beer`.', "\n"
         end
       end