lib/gist_updater/commands.rb in gist_updater-0.3.0 vs lib/gist_updater/commands.rb in gist_updater-0.3.1

@@ -1,10 +1,11 @@
 # frozen_string_literal: true
 
 require 'thor'
 
 module GistUpdater
+  # CLI Interface
   class Commands < Thor
     package_name 'gist_updater'
     default_task :update
     class_option :yaml, type: :string, aliases: :y,
                         desc: 'User definition YAML file',
@@ -15,14 +16,20 @@
                          desc: 'GitHub personal access token'
     class_option :debug, type: :boolean, aliases: :d,
                          desc: 'Debug mode', default: false
 
     desc 'update', 'Update your Gist files (default)'
+    # CLI Interface to update your Gist
+    #
+    # @return (see GistUpdater::Updater#update)
     def update
       Updater.new(options).update
     end
 
     desc 'version', 'Display version'
+    # CLI Interface to display version
+    #
+    # @return (see Kernel.puts)
     def version
       puts VERSION
     end
   end
 end