fix: yard example tag formatting (#59)

Author: stainless-app[bot]

lib/finch-api/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/finch-api/base_model.rb

@@ -288,33 +288,29 @@ def try_strict_coerce(value)
   #   values safely.
   #
   # @example
-  # ```ruby
-  # # `connection_status_type` is a `FinchAPI::Models::ConnectionStatusType`
-  # case connection_status_type
-  # when FinchAPI::Models::ConnectionStatusType::PENDING
-  #   # ...
-  # when FinchAPI::Models::ConnectionStatusType::PROCESSING
-  #   # ...
-  # when FinchAPI::Models::ConnectionStatusType::CONNECTED
-  #   # ...
-  # else
-  #   puts(connection_status_type)
-  # end
-  # ```
+  #   # `connection_status_type` is a `FinchAPI::Models::ConnectionStatusType`
+  #   case connection_status_type
+  #   when FinchAPI::Models::ConnectionStatusType::PENDING
+  #     # ...
+  #   when FinchAPI::Models::ConnectionStatusType::PROCESSING
+  #     # ...
+  #   when FinchAPI::Models::ConnectionStatusType::CONNECTED
+  #     # ...
+  #   else
+  #     puts(connection_status_type)
+  #   end
   #
   # @example
-  # ```ruby
-  # case connection_status_type
-  # in :pending
-  #   # ...
-  # in :processing
-  #   # ...
-  # in :connected
-  #   # ...
-  # else
-  #   puts(connection_status_type)
-  # end
-  # ```
+  #   case connection_status_type
+  #   in :pending
+  #     # ...
+  #   in :processing
+  #     # ...
+  #   in :connected
+  #     # ...
+  #   else
+  #     puts(connection_status_type)
+  #   end
   module Enum
     include FinchAPI::Converter
 
@@ -387,29 +383,25 @@ def try_strict_coerce(value)
   # @api private
   #
   # @example
-  # ```ruby
-  # # `document_retreive_response` is a `FinchAPI::Models::HRIS::DocumentRetreiveResponse`
-  # case document_retreive_response
-  # when FinchAPI::Models::HRIS::W42020
-  #   puts(document_retreive_response.data)
-  # when FinchAPI::Models::HRIS::W42005
-  #   puts(document_retreive_response.type)
-  # else
-  #   puts(document_retreive_response)
-  # end
-  # ```
+  #   # `document_retreive_response` is a `FinchAPI::Models::HRIS::DocumentRetreiveResponse`
+  #   case document_retreive_response
+  #   when FinchAPI::Models::HRIS::W42020
+  #     puts(document_retreive_response.data)
+  #   when FinchAPI::Models::HRIS::W42005
+  #     puts(document_retreive_response.type)
+  #   else
+  #     puts(document_retreive_response)
+  #   end
   #
   # @example
-  # ```ruby
-  # case document_retreive_response
-  # in {type: :w4_2020, data: data, year: year}
-  #   puts(data)
-  # in {type: :w4_2005, data: data, year: year}
-  #   puts(year)
-  # else
-  #   puts(document_retreive_response)
-  # end
-  # ```
+  #   case document_retreive_response
+  #   in {type: :w4_2020, data: data, year: year}
+  #     puts(data)
+  #   in {type: :w4_2005, data: data, year: year}
+  #     puts(year)
+  #   else
+  #     puts(document_retreive_response)
+  #   end
   module Union
     include FinchAPI::Converter
 
@@ -874,14 +866,12 @@ def initialize(type_info, spec = {})
   # @abstract
   #
   # @example
-  # ```ruby
-  # # `operation_support_matrix` is a `FinchAPI::Models::OperationSupportMatrix`
-  # operation_support_matrix => {
-  #   create: create,
-  #   delete: delete,
-  #   read: read
-  # }
-  # ```
+  #   # `operation_support_matrix` is a `FinchAPI::Models::OperationSupportMatrix`
+  #   operation_support_matrix => {
+  #     create: create,
+  #     delete: delete,
+  #     read: read
+  #   }
   class BaseModel
     extend FinchAPI::Converter
 

lib/finch-api/base_page.rb

@@ -2,32 +2,26 @@
 
 module FinchAPI
   # @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 |access_token|
-  #   puts(access_token)
-  # end
-  # ```
+  #   page.auto_paging_each do |access_token|
+  #     puts(access_token)
+  #   end
   #
   # @example
-  # ```ruby
-  # access_tokens =
-  #   page
-  #   .to_enum
-  #   .lazy
-  #   .select { _1.object_id.even? }
-  #   .map(&:itself)
-  #   .take(2)
-  #   .to_a
+  #   access_tokens =
+  #     page
+  #     .to_enum
+  #     .lazy
+  #     .select { _1.object_id.even? }
+  #     .map(&:itself)
+  #     .take(2)
+  #     .to_a
   #
-  # access_tokens => Array
-  # ```
+  #   access_tokens => Array
   module BasePage
     # rubocop:disable Lint/UnusedMethodArgument
 

lib/finch-api/individuals_page.rb

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

lib/finch-api/page.rb

@@ -2,32 +2,26 @@
 
 module FinchAPI
   # @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 |item|
-  #   puts(item)
-  # end
-  # ```
+  #   page.auto_paging_each do |item|
+  #     puts(item)
+  #   end
   #
   # @example
-  # ```ruby
-  # items =
-  #   page
-  #   .to_enum
-  #   .lazy
-  #   .select { _1.object_id.even? }
-  #   .map(&:itself)
-  #   .take(2)
-  #   .to_a
+  #   items =
+  #     page
+  #     .to_enum
+  #     .lazy
+  #     .select { _1.object_id.even? }
+  #     .map(&:itself)
+  #     .take(2)
+  #     .to_a
   #
-  # items => Array
-  # ```
+  #   items => Array
   class Page
     include FinchAPI::BasePage
 

lib/finch-api/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, FinchAPI::HashOf[FinchAPI::Unknown]
 
     # @!attribute max_retries

lib/finch-api/responses_page.rb

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

lib/finch-api/single_page.rb

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

rbi/lib/finch-api/request_options.rbi

@@ -73,11 +73,11 @@ module FinchAPI
 
     # 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