Improve type documentation

apainintheneck · Feb 20, 2024 · b9c0f4b · b9c0f4b
1 parent 34a6592
commit b9c0f4b
Show file tree

Hide file tree

Showing 7 changed files with 14 additions and 0 deletions.
diff --git a/lib/atlasq.rb b/lib/atlasq.rb
@@ -18,6 +18,7 @@ def self.failed!
     @failed = true
   end
 
+  # @return [Boolean]
   def self.failed?
     !!@failed
   end

diff --git a/lib/atlasq/command.rb b/lib/atlasq/command.rb
@@ -14,6 +14,8 @@ module Command
     # @param args [Array<String>]
     Options = Struct.new(:command, :args, keyword_init: true)
 
+    # @param args [Array<String>] command line arguments
+    # @return [Atlasq::Command::Options]
     def self.parse(args)
       command = parse_command(args.first)
       args.shift unless command.to_s == "Atlasq::Command::Any"
@@ -22,6 +24,8 @@ def self.parse(args)
       Options.new(command: command, args: args).freeze
     end
 
+    # @param command [String]
+    # @return [Atlasq::Command::Base]
     def self.parse_command(command)
       case command
       when "-c", "--country", "--countries"

diff --git a/lib/atlasq/command/any.rb b/lib/atlasq/command/any.rb
@@ -5,6 +5,7 @@
 module Atlasq
   module Command
     class Any < Base
+      # @return [String]
       def content
         search_terms.map do |term|
           if (country = Data.country(term))

diff --git a/lib/atlasq/command/money.rb b/lib/atlasq/command/money.rb
@@ -5,6 +5,7 @@
 module Atlasq
   module Command
     class Money < Base
+      # @return [String]
       def content
         if search_terms.empty?
           currencies = Data.all_currencies

diff --git a/lib/atlasq/command/region.rb b/lib/atlasq/command/region.rb
@@ -5,6 +5,7 @@
 module Atlasq
   module Command
     class Region < Base
+      # @return [String]
       def content
         if search_terms.empty?
           subregions = Data.all_subregions

diff --git a/lib/atlasq/format.rb b/lib/atlasq/format.rb
@@ -141,6 +141,8 @@ def self.currencies(currencies, partial_match: false)
       end
     end
 
+    # @param country_code [String]
+    # @return [String]
     def self.one_line_currency(currency_code)
       Cache
         .get("formatted_output/one_line_currency.json")

diff --git a/lib/atlasq/shell.rb b/lib/atlasq/shell.rb
@@ -4,6 +4,7 @@ module Atlasq
   module Shell
     SKIP_PAGER = %i[usage version].freeze
 
+    # @param [Array<String>] command line arguments
     def self.start!(args = ARGV)
       warn "DEBUG: args: #{args}" if DEBUG
       options = Command.parse(args)
@@ -24,6 +25,9 @@ def self.start!(args = ARGV)
 
     DEFAULT_SHELL_HEIGHT = 24
 
+    # @param options [Atlasq::Command::Options]
+    # @param content [String]
+    # @return [Boolean]
     def self.use_pager?(options, content)
       $stdout.tty? &&
         options.command.to_pager? &&