From bbee8e927fbc0d0d44a55a20a0e66a0dcd326138 Mon Sep 17 00:00:00 2001 From: "stainless-app[bot]" <142633134+stainless-app[bot]@users.noreply.github.com> Date: Tue, 18 Mar 2025 23:20:09 +0000 Subject: [PATCH] chore: add `@yieldparam` to yard doc --- lib/openai/pooled_net_requester.rb | 4 ++++ lib/openai/util.rb | 4 ++++ 2 files changed, 8 insertions(+) diff --git a/lib/openai/pooled_net_requester.rb b/lib/openai/pooled_net_requester.rb index c6b17713..a7e5242a 100644 --- a/lib/openai/pooled_net_requester.rb +++ b/lib/openai/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 = OpenAI::Util.uri_origin(url) timeout = deadline - OpenAI::Util.monotonic_secs diff --git a/lib/openai/util.rb b/lib/openai/util.rb index a372dfa3..a06aa76e 100644 --- a/lib/openai/util.rb +++ b/lib/openai/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) }