summaryrefslogtreecommitdiffhomepage
diff options
context:
space:
mode:
authorGeremia Taglialatela <[email protected]>2023-05-18 09:31:09 +0200
committerGeremia Taglialatela <[email protected]>2023-05-18 09:31:09 +0200
commited25dade53fd5e4d74d9d171fcc62e3fc2cd68a7 (patch)
treee896ad6924a0230d3fd73fdcc899192e06890f35
parent6a4b82def2e94b4811c38c37e606d426710d1e6c (diff)
downloadcaxlsx-ed25dade53fd5e4d74d9d171fcc62e3fc2cd68a7.tar.gz
caxlsx-ed25dade53fd5e4d74d9d171fcc62e3fc2cd68a7.zip
Fix YARD warnings
- `should_use_same_id_as?` has been replaced by `ids_cache_key` in 913003e Also fixes a typo [ci skip]
-rw-r--r--lib/axlsx.rb4
-rw-r--r--lib/axlsx/rels/relationship.rb2
-rw-r--r--lib/axlsx/workbook/worksheet/cell.rb4
-rw-r--r--lib/axlsx/workbook/worksheet/worksheet.rb6
4 files changed, 8 insertions, 8 deletions
diff --git a/lib/axlsx.rb b/lib/axlsx.rb
index 815e0440..cb7beb8c 100644
--- a/lib/axlsx.rb
+++ b/lib/axlsx.rb
@@ -192,8 +192,8 @@ module Axlsx
end
# utility method for performing a deep merge on a Hash
- # @param [Hash] Hash to merge into
- # @param [Hash] Hash to be added
+ # @param [Hash] first_hash Hash to merge into
+ # @param [Hash] second_hash Hash to be added
def self.hash_deep_merge(first_hash, second_hash)
first_hash.merge(second_hash) do |_key, this_val, other_val|
if this_val.is_a?(Hash) && other_val.is_a?(Hash)
diff --git a/lib/axlsx/rels/relationship.rb b/lib/axlsx/rels/relationship.rb
index 14d15457..93cdc88b 100644
--- a/lib/axlsx/rels/relationship.rb
+++ b/lib/axlsx/rels/relationship.rb
@@ -43,7 +43,7 @@ module Axlsx
end
# The id of the relationship (eg. "rId123"). Most instances get their own unique id.
- # However, some instances need to share the same id – see {#should_use_same_id_as?}
+ # However, some instances need to share the same id – see {#ids_cache_key}
# for details.
# @return [String]
attr_reader :Id
diff --git a/lib/axlsx/workbook/worksheet/cell.rb b/lib/axlsx/workbook/worksheet/cell.rb
index 4d1bae63..c978bde4 100644
--- a/lib/axlsx/workbook/worksheet/cell.rb
+++ b/lib/axlsx/workbook/worksheet/cell.rb
@@ -83,7 +83,7 @@ module Axlsx
attr_accessor :raw_style
# The index of the cellXfs item to be applied to this cell.
- # @param [Hash] styles
+ # @param [Hash] style
# @see Axlsx::Styles
def add_style(style)
self.raw_style ||= {}
@@ -115,7 +115,7 @@ module Axlsx
# automatically determed.
# @see Cell#cell_type_from_value
# @return [Symbol] The type of data this cell's value is cast to.
- # @raise [ArgumentExeption] Cell.type must be one of [:date, time, :float, :integer, :string, :boolean]
+ # @raise [ArgumentError] Cell.type must be one of [:date, time, :float, :integer, :string, :boolean]
# @note
# If the value provided cannot be cast into the type specified, type is changed to :string and the following logic is applied.
# :string to :integer or :float, type conversions always return 0 or 0.0
diff --git a/lib/axlsx/workbook/worksheet/worksheet.rb b/lib/axlsx/workbook/worksheet/worksheet.rb
index 21c53409..c76300f2 100644
--- a/lib/axlsx/workbook/worksheet/worksheet.rb
+++ b/lib/axlsx/workbook/worksheet/worksheet.rb
@@ -581,7 +581,7 @@ module Axlsx
end
# Set the style for cells in a specific column
- # @param [String|Array] cell references
+ # @param [String|Array] cell_refs Cell references
# @param [Hash] styles
def add_style(cell_refs, *styles)
if !cell_refs.is_a?(Array)
@@ -602,8 +602,8 @@ module Axlsx
end
# Set the style for cells in a specific column
- # @param [String|Array] cell references
- # @param [Hash|Array|Symbol] border options
+ # @param [String|Array] cell_refs Cell references
+ # @param [Hash|Array|Symbol] options border options
def add_border(cell_refs, options = nil)
if options.is_a?(Hash)
border_edges = options[:edges]