Skip to content

Commit

Permalink
Add yarddoc generation and fixup some errors
Browse files Browse the repository at this point in the history
The `yard` rake task is now included by default.

And 2 small errors in the docs have been fixed.
  • Loading branch information
acant committed Oct 28, 2022
1 parent 476722c commit ffacc74
Show file tree
Hide file tree
Showing 2 changed files with 3 additions and 3 deletions.
2 changes: 1 addition & 1 deletion Rakefile
Original file line number Diff line number Diff line change
Expand Up @@ -64,4 +64,4 @@ task 'bundle:outdated' do
sh("bundle outdated --only-explicit | tee #{bundle_outdated_report_pathname}")
end

task default: %i[spec features rubocop yardstick_measure bundle:audit license_finder]
task default: %i[spec features rubocop yard yardstick_measure bundle:audit license_finder]
4 changes: 2 additions & 2 deletions lib/sugar_utils/file/write_options.rb
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,7 @@ module SugarUtils
module File
# @api private
class WriteOptions
# @parma filename [String]
# @param filename [String]
# @param options [Hash]
def initialize(filename, options)
@filename = filename
Expand Down Expand Up @@ -47,7 +47,7 @@ def group
@options[:group] || @existing_group
end

# @param keys [Array]
# @param args [Array]
# @return [Hash]
def slice(*args)
keys = args.flatten.compact
Expand Down

0 comments on commit ffacc74

Please sign in to comment.