Tweak yieldparam YARD comments

julik · Apr 21, 2024 · 69b8906 · 69b8906
1 parent 383589f
commit 69b8906
Show file tree

Hide file tree

Showing 2 changed files with 2 additions and 2 deletions.
diff --git a/lib/zip_kit/rails_streaming.rb b/lib/zip_kit/rails_streaming.rb
@@ -24,7 +24,7 @@ module ZipKit::RailsStreaming
   # @param use_chunked_transfer_encoding[Boolean] whether to forcibly encode output as chunked. Normally you should not need this.
   # @param output_enumerator_options[Hash] options that will be passed to the OutputEnumerator - these include
   #     options for the Streamer. See {ZipKit::OutputEnumerator#initialize} for the full list of options.
-  # @yieldparam [ZipKit::Streamer] zip the {ZipKit::Streamer} that can be written to
+  # @yieldparam zip[ZipKit::Streamer] the {ZipKit::Streamer} that can be written to
   # @return [Boolean] always returns true
   def zip_kit_stream(filename: "download.zip", type: "application/zip", use_chunked_transfer_encoding: false, **output_enumerator_options, &zip_streaming_blk)
     # We want some common headers for file sending. Rails will also set

diff --git a/lib/zip_kit/size_estimator.rb b/lib/zip_kit/size_estimator.rb
@@ -24,7 +24,7 @@ def initialize(streamer)
   #
   # @param kwargs_for_streamer_new Any options to pass to Streamer, see {Streamer#initialize}
   # @return [Integer] the size of the resulting archive, in bytes
-  # @yieldparam [SizeEstimator] the estimator
+  # @yieldparam estimator[SizeEstimator] the estimator
   def self.estimate(**kwargs_for_streamer_new)
     streamer = ZipKit::Streamer.new(ZipKit::NullWriter, **kwargs_for_streamer_new)
     estimator = new(streamer)