lib/reviewer/arguments/keywords.rb in reviewer-0.1.4 vs lib/reviewer/arguments/keywords.rb in reviewer-0.1.5
- old
+ new
@@ -2,20 +2,23 @@
module Reviewer
class Arguments
# Handles interpreting all 'leftover' arguments and translating them to file-related,
# tag-related, or tool-related arguments
+ #
+ # @!attribute provided
+ # @return [Array<String>] the keywords extracted from the command-line arguments
class Keywords
RESERVED = %w[staged].freeze
attr_accessor :provided
alias raw provided
- # Generates an instace of parsed keywords from the provided arguments
+ # Generates an instance of parsed keywords from the provided arguments
# @param *provided [Array<String>] the leftover (non-flag) arguments from the command line
#
- # @return [Arguments::Keywords]
+ # @return [self]
def initialize(*provided)
@provided = Array(provided.flatten)
end
# Proves the full list of raw keyword arguments explicitly passed via command-line as an array