fix: yard example tag formatting (#53)

Author: stainless-app[bot]

lib/openai/base_client.rb

@@ -220,7 +220,7 @@ def initialize(
     #
     #   @option opts [Hash{String=>String, nil}, nil] :extra_headers
     #
-    #   @option opts [Hash{Symbol=>Object}, nil] :extra_body
+    #   @option opts [Object, nil] :extra_body
     #
     #   @option opts [Integer, nil] :max_retries
     #

lib/openai/base_model.rb

@@ -288,33 +288,29 @@ def try_strict_coerce(value)
   #   values safely.
   #
   # @example
-  # ```ruby
-  # # `chat_model` is a `OpenAI::Models::ChatModel`
-  # case chat_model
-  # when OpenAI::Models::ChatModel::O3_MINI
-  #   # ...
-  # when OpenAI::Models::ChatModel::O3_MINI_2025_01_31
-  #   # ...
-  # when OpenAI::Models::ChatModel::O1
-  #   # ...
-  # else
-  #   puts(chat_model)
-  # end
-  # ```
+  #   # `chat_model` is a `OpenAI::Models::ChatModel`
+  #   case chat_model
+  #   when OpenAI::Models::ChatModel::O3_MINI
+  #     # ...
+  #   when OpenAI::Models::ChatModel::O3_MINI_2025_01_31
+  #     # ...
+  #   when OpenAI::Models::ChatModel::O1
+  #     # ...
+  #   else
+  #     puts(chat_model)
+  #   end
   #
   # @example
-  # ```ruby
-  # case chat_model
-  # in :"o3-mini"
-  #   # ...
-  # in :"o3-mini-2025-01-31"
-  #   # ...
-  # in :o1
-  #   # ...
-  # else
-  #   puts(chat_model)
-  # end
-  # ```
+  #   case chat_model
+  #   in :"o3-mini"
+  #     # ...
+  #   in :"o3-mini-2025-01-31"
+  #     # ...
+  #   in :o1
+  #     # ...
+  #   else
+  #     puts(chat_model)
+  #   end
   module Enum
     include OpenAI::Converter
 
@@ -387,33 +383,29 @@ def try_strict_coerce(value)
   # @api private
   #
   # @example
-  # ```ruby
-  # # `chat_completion_content_part` is a `OpenAI::Models::Chat::ChatCompletionContentPart`
-  # case chat_completion_content_part
-  # when OpenAI::Models::Chat::ChatCompletionContentPartText
-  #   puts(chat_completion_content_part.text)
-  # when OpenAI::Models::Chat::ChatCompletionContentPartImage
-  #   puts(chat_completion_content_part.image_url)
-  # when OpenAI::Models::Chat::ChatCompletionContentPartInputAudio
-  #   puts(chat_completion_content_part.input_audio)
-  # else
-  #   puts(chat_completion_content_part)
-  # end
-  # ```
+  #   # `chat_completion_content_part` is a `OpenAI::Models::Chat::ChatCompletionContentPart`
+  #   case chat_completion_content_part
+  #   when OpenAI::Models::Chat::ChatCompletionContentPartText
+  #     puts(chat_completion_content_part.text)
+  #   when OpenAI::Models::Chat::ChatCompletionContentPartImage
+  #     puts(chat_completion_content_part.image_url)
+  #   when OpenAI::Models::Chat::ChatCompletionContentPartInputAudio
+  #     puts(chat_completion_content_part.input_audio)
+  #   else
+  #     puts(chat_completion_content_part)
+  #   end
   #
   # @example
-  # ```ruby
-  # case chat_completion_content_part
-  # in {type: :text, text: text}
-  #   puts(text)
-  # in {type: :image_url, image_url: image_url}
-  #   puts(image_url)
-  # in {type: :input_audio, input_audio: input_audio}
-  #   puts(input_audio)
-  # else
-  #   puts(chat_completion_content_part)
-  # end
-  # ```
+  #   case chat_completion_content_part
+  #   in {type: :text, text: text}
+  #     puts(text)
+  #   in {type: :image_url, image_url: image_url}
+  #     puts(image_url)
+  #   in {type: :input_audio, input_audio: input_audio}
+  #     puts(input_audio)
+  #   else
+  #     puts(chat_completion_content_part)
+  #   end
   module Union
     include OpenAI::Converter
 
@@ -878,14 +870,12 @@ def initialize(type_info, spec = {})
   # @abstract
   #
   # @example
-  # ```ruby
-  # # `comparison_filter` is a `OpenAI::Models::ComparisonFilter`
-  # comparison_filter => {
-  #   key: key,
-  #   type: type,
-  #   value: value
-  # }
-  # ```
+  #   # `comparison_filter` is a `OpenAI::Models::ComparisonFilter`
+  #   comparison_filter => {
+  #     key: key,
+  #     type: type,
+  #     value: value
+  #   }
   class BaseModel
     extend OpenAI::Converter
 

lib/openai/base_page.rb

@@ -2,32 +2,26 @@
 
 module OpenAI
   # @example
-  # ```ruby
-  # if page.has_next?
-  #   page = page.next_page
-  # end
-  # ```
+  #   if page.has_next?
+  #     page = page.next_page
+  #   end
   #
   # @example
-  # ```ruby
-  # page.auto_paging_each do |completion|
-  #   puts(completion)
-  # end
-  # ```
+  #   page.auto_paging_each do |completion|
+  #     puts(completion)
+  #   end
   #
   # @example
-  # ```ruby
-  # completions =
-  #   page
-  #   .to_enum
-  #   .lazy
-  #   .select { _1.object_id.even? }
-  #   .map(&:itself)
-  #   .take(2)
-  #   .to_a
+  #   completions =
+  #     page
+  #     .to_enum
+  #     .lazy
+  #     .select { _1.object_id.even? }
+  #     .map(&:itself)
+  #     .take(2)
+  #     .to_a
   #
-  # completions => Array
-  # ```
+  #   completions => Array
   module BasePage
     # rubocop:disable Lint/UnusedMethodArgument
 

lib/openai/base_stream.rb

@@ -2,24 +2,20 @@
 
 module OpenAI
   # @example
-  # ```ruby
-  # stream.each do |chunk|
-  #   puts(chunk)
-  # end
-  # ```
+  #   stream.each do |chunk|
+  #     puts(chunk)
+  #   end
   #
   # @example
-  # ```ruby
-  # chunks =
-  #   stream
-  #   .lazy
-  #   .select { _1.object_id.even? }
-  #   .map(&:itself)
-  #   .take(2)
-  #   .to_a
+  #   chunks =
+  #     stream
+  #     .lazy
+  #     .select { _1.object_id.even? }
+  #     .map(&:itself)
+  #     .take(2)
+  #     .to_a
   #
-  # chunks => Array
-  # ```
+  #   chunks => Array
   module BaseStream
     include Enumerable
 

lib/openai/cursor_page.rb

@@ -2,32 +2,26 @@
 
 module OpenAI
   # @example
-  # ```ruby
-  # if cursor_page.has_next?
-  #   cursor_page = cursor_page.next_page
-  # end
-  # ```
+  #   if cursor_page.has_next?
+  #     cursor_page = cursor_page.next_page
+  #   end
   #
   # @example
-  # ```ruby
-  # cursor_page.auto_paging_each do |completion|
-  #   puts(completion)
-  # end
-  # ```
+  #   cursor_page.auto_paging_each do |completion|
+  #     puts(completion)
+  #   end
   #
   # @example
-  # ```ruby
-  # completions =
-  #   cursor_page
-  #   .to_enum
-  #   .lazy
-  #   .select { _1.object_id.even? }
-  #   .map(&:itself)
-  #   .take(2)
-  #   .to_a
+  #   completions =
+  #     cursor_page
+  #     .to_enum
+  #     .lazy
+  #     .select { _1.object_id.even? }
+  #     .map(&:itself)
+  #     .take(2)
+  #     .to_a
   #
-  # completions => Array
-  # ```
+  #   completions => Array
   class CursorPage
     include OpenAI::BasePage
 

lib/openai/page.rb

@@ -2,32 +2,26 @@
 
 module OpenAI
   # @example
-  # ```ruby
-  # if page.has_next?
-  #   page = page.next_page
-  # end
-  # ```
+  #   if page.has_next?
+  #     page = page.next_page
+  #   end
   #
   # @example
-  # ```ruby
-  # page.auto_paging_each do |model|
-  #   puts(model)
-  # end
-  # ```
+  #   page.auto_paging_each do |model|
+  #     puts(model)
+  #   end
   #
   # @example
-  # ```ruby
-  # models =
-  #   page
-  #   .to_enum
-  #   .lazy
-  #   .select { _1.object_id.even? }
-  #   .map(&:itself)
-  #   .take(2)
-  #   .to_a
+  #   models =
+  #     page
+  #     .to_enum
+  #     .lazy
+  #     .select { _1.object_id.even? }
+  #     .map(&:itself)
+  #     .take(2)
+  #     .to_a
   #
-  # models => Array
-  # ```
+  #   models => Array
   class Page
     include OpenAI::BasePage
 

lib/openai/request_options.rb

@@ -83,7 +83,7 @@ def self.validate!(opts)
     #   Extra data to send with the request. These are deep merged into any data
     #     generated as part of the normal request.
     #
-    #   @return [Hash{Symbol=>Object}, nil]
+    #   @return [Object, nil]
     optional :extra_body, OpenAI::HashOf[OpenAI::Unknown]
 
     # @!attribute max_retries

lib/openai/stream.rb

@@ -2,24 +2,20 @@
 
 module OpenAI
   # @example
-  # ```ruby
-  # stream.each do |event|
-  #   puts(event)
-  # end
-  # ```
+  #   stream.each do |event|
+  #     puts(event)
+  #   end
   #
   # @example
-  # ```ruby
-  # events =
-  #   stream
-  #   .lazy
-  #   .select { _1.object_id.even? }
-  #   .map(&:itself)
-  #   .take(2)
-  #   .to_a
+  #   events =
+  #     stream
+  #     .lazy
+  #     .select { _1.object_id.even? }
+  #     .map(&:itself)
+  #     .take(2)
+  #     .to_a
   #
-  # events => Array
-  # ```
+  #   events => Array
   class Stream
     include OpenAI::BaseStream
 

rbi/lib/openai/request_options.rbi

@@ -73,11 +73,11 @@ module OpenAI
 
     # Extra data to send with the request. These are deep merged into any data
     #   generated as part of the normal request.
-    sig { returns(T.nilable(T::Hash[Symbol, T.anything])) }
+    sig { returns(T.nilable(T.anything)) }
     def extra_body
     end
 
-    sig { params(_: T.nilable(T::Hash[Symbol, T.anything])).returns(T.nilable(T::Hash[Symbol, T.anything])) }
+    sig { params(_: T.nilable(T.anything)).returns(T.nilable(T.anything)) }
     def extra_body=(_)
     end
 

sig/openai/request_options.rbs

@@ -17,7 +17,7 @@ module OpenAI
       idempotency_key: String?,
       extra_query: ::Hash[String, (::Array[String] | String)?]?,
       extra_headers: ::Hash[String, String?]?,
-      extra_body: ::Hash[Symbol, top]?,
+      extra_body: top?,
       max_retries: Integer?,
       timeout: Float?
     }
@@ -31,7 +31,7 @@ module OpenAI
 
     attr_accessor extra_headers: ::Hash[String, String?]?
 
-    attr_accessor extra_body: ::Hash[Symbol, top]?
+    attr_accessor extra_body: top?
 
     attr_accessor max_retries: Integer?