chore: add @yieldparam to yard doc (#170)

Author: stainless-app[bot]

.rubocop.yml

@@ -83,6 +83,12 @@ Lint/UnusedMethodArgument:
 Metrics/AbcSize:
   Enabled: false
 
+Metrics/BlockLength:
+  AllowedPatterns:
+    - assert_pattern
+  Exclude:
+    - "**/*.rbi"
+
 Metrics/ClassLength:
   Enabled: false
 
@@ -92,6 +98,10 @@ Metrics/CyclomaticComplexity:
 Metrics/MethodLength:
   Enabled: false
 
+Metrics/ModuleLength:
+  Exclude:
+    - "**/*.rbi"
+
 Metrics/ParameterLists:
   Enabled: false
 
@@ -102,10 +112,18 @@ Naming/BlockForwarding:
   Exclude:
     - "**/*.rbi"
 
+Naming/ClassAndModuleCamelCase:
+  Exclude:
+    - "**/*.rbi"
+
 Naming/MethodParameterName:
   Exclude:
     - "**/*.rbi"
 
+Naming/PredicateName:
+  Exclude:
+    - "**/*.rbi"
+
 Naming/VariableNumber:
   Enabled: false
 

lib/orb/pooled_net_requester.rb

@@ -51,6 +51,7 @@ def calibrate_socket_timeout(conn, deadline)
       #
       # @param blk [Proc]
       #
+      # @yieldparam [String]
       # @return [Net::HTTPGenericRequest]
       def build_request(request, &)
         method, url, headers, body = request.fetch_values(:method, :url, :headers, :body)
@@ -86,6 +87,9 @@ def build_request(request, &)
     # @param url [URI::Generic]
     # @param deadline [Float]
     # @param blk [Proc]
+    #
+    # @raise [Timeout::Error]
+    # @yieldparam [Net::HTTP]
     private def with_pool(url, deadline:, &blk)
       origin = Orb::Util.uri_origin(url)
       timeout = deadline - Orb::Util.monotonic_secs

lib/orb/util.rb

@@ -429,6 +429,8 @@ def read(max_len = nil, out_string = nil)
       #
       # @param stream [String, IO, StringIO, Enumerable]
       # @param blk [Proc]
+      #
+      # @yieldparam [String]
       def initialize(stream, &blk)
         @stream = stream.is_a?(String) ? StringIO.new(stream) : stream
         @buf = String.new.b
@@ -439,6 +441,7 @@ def initialize(stream, &blk)
     class << self
       # @param blk [Proc]
       #
+      # @yieldparam [Enumerator::Yielder]
       # @return [Enumerable]
       def string_io(&blk)
         Enumerator.new do |y|
@@ -633,6 +636,7 @@ def close_fused!(enum)
       # @param enum [Enumerable, nil]
       # @param blk [Proc]
       #
+      # @yieldparam [Enumerator::Yielder]
       # @return [Enumerable]
       def chain_fused(enum, &blk)
         iter = Enumerator.new { blk.call(_1) }