chore: update yard comment formatting (#126)

Author: stainless-app[bot]

.solargraph.yml

@@ -5,6 +5,7 @@ include:
   - 'Rakefile'
   - 'examples/**/*.rb'
   - 'lib/**/*.rb'
+  - 'test/finch-api/resource_namespaces.rb'
   - 'test/finch-api/test_helper.rb'
 exclude:
   - 'rbi/**/*'

lib/finch_api/internal/transport/base_client.rb

@@ -393,7 +393,7 @@ def initialize(
         end
 
         # Execute the request specified by `req`. This is the method that all resource
-        #   methods call into.
+        # methods call into.
         #
         # @overload request(method, path, query: {}, headers: {}, body: nil, unwrap: nil, page: nil, stream: nil, model: FinchAPI::Internal::Type::Unknown, options: {})
         #

lib/finch_api/internal/transport/pooled_net_requester.rb

@@ -6,7 +6,7 @@ module Transport
       # @api private
       class PooledNetRequester
         # from the golang stdlib
-        #   https://github.com/golang/go/blob/c8eced8580028328fde7c03cbfcb720ce15b2358/src/net/http/transport.go#L49
+        # https://github.com/golang/go/blob/c8eced8580028328fde7c03cbfcb720ce15b2358/src/net/http/transport.go#L49
         KEEP_ALIVE_TIMEOUT = 30
 
         class << self

lib/finch_api/internal/type/base_model.rb

@@ -19,7 +19,7 @@ class << self
           # @api private
           #
           # Assumes superclass fields are totally defined before fields are accessed /
-          #   defined on subclasses.
+          # defined on subclasses.
           #
           # @return [Hash{Symbol=>Hash{Symbol=>Object}}]
           def known_fields
@@ -150,7 +150,7 @@ def optional(name_sym, type_info, spec = {})
           # @api private
           #
           # `request_only` attributes not excluded from `.#coerce` when receiving responses
-          #   even if well behaved servers should not send them
+          # even if well behaved servers should not send them
           #
           # @param blk [Proc]
           private def request_only(&blk)
@@ -298,11 +298,11 @@ def dump(value)
         end
 
         # Returns the raw value associated with the given key, if found. Otherwise, nil is
-        #   returned.
+        # returned.
         #
-        #   It is valid to lookup keys that are not in the API spec, for example to access
-        #   undocumented features. This method does not parse response data into
-        #   higher-level types. Lookup by anything other than a Symbol is an ArgumentError.
+        # It is valid to lookup keys that are not in the API spec, for example to access
+        # undocumented features. This method does not parse response data into
+        # higher-level types. Lookup by anything other than a Symbol is an ArgumentError.
         #
         # @param key [Symbol]
         #
@@ -317,12 +317,12 @@ def [](key)
 
         # Returns a Hash of the data underlying this object. O(1)
         #
-        #   Keys are Symbols and values are the raw values from the response. The return
-        #   value indicates which values were ever set on the object. i.e. there will be a
-        #   key in this hash if they ever were, even if the set value was nil.
+        # Keys are Symbols and values are the raw values from the response. The return
+        # value indicates which values were ever set on the object. i.e. there will be a
+        # key in this hash if they ever were, even if the set value was nil.
         #
-        #   This method is not recursive. The returned value is shared by the object, so it
-        #   should not be mutated.
+        # This method is not recursive. The returned value is shared by the object, so it
+        # should not be mutated.
         #
         # @return [Hash{Symbol=>Object}]
         def to_h = @data

lib/finch_api/internal/type/converter.rb

@@ -75,37 +75,37 @@ def type_info(spec)
           #
           # Based on `target`, transform `value` into `target`, to the extent possible:
           #
-          #   1. if the given `value` conforms to `target` already, return the given `value`
-          #   2. if it's possible and safe to convert the given `value` to `target`, then the
-          #      converted value
-          #   3. otherwise, the given `value` unaltered
+          # 1. if the given `value` conforms to `target` already, return the given `value`
+          # 2. if it's possible and safe to convert the given `value` to `target`, then the
+          #    converted value
+          # 3. otherwise, the given `value` unaltered
           #
-          #   The coercion process is subject to improvement between minor release versions.
-          #   See https://docs.pydantic.dev/latest/concepts/unions/#smart-mode
+          # The coercion process is subject to improvement between minor release versions.
+          # See https://docs.pydantic.dev/latest/concepts/unions/#smart-mode
           #
           # @param target [FinchAPI::Internal::Type::Converter, Class]
           #
           # @param value [Object]
           #
           # @param state [Hash{Symbol=>Object}] The `strictness` is one of `true`, `false`, or `:strong`. This informs the
-          #   coercion strategy when we have to decide between multiple possible conversion
-          #   targets:
+          # coercion strategy when we have to decide between multiple possible conversion
+          # targets:
           #
-          #   - `true`: the conversion must be exact, with minimum coercion.
-          #   - `false`: the conversion can be approximate, with some coercion.
-          #   - `:strong`: the conversion must be exact, with no coercion, and raise an error
-          #     if not possible.
+          # - `true`: the conversion must be exact, with minimum coercion.
+          # - `false`: the conversion can be approximate, with some coercion.
+          # - `:strong`: the conversion must be exact, with no coercion, and raise an error
+          #   if not possible.
           #
-          #   The `exactness` is `Hash` with keys being one of `yes`, `no`, or `maybe`. For
-          #   any given conversion attempt, the exactness will be updated based on how closely
-          #   the value recursively matches the target type:
+          # The `exactness` is `Hash` with keys being one of `yes`, `no`, or `maybe`. For
+          # any given conversion attempt, the exactness will be updated based on how closely
+          # the value recursively matches the target type:
           #
-          #   - `yes`: the value can be converted to the target type with minimum coercion.
-          #   - `maybe`: the value can be converted to the target type with some reasonable
-          #     coercion.
-          #   - `no`: the value cannot be converted to the target type.
+          # - `yes`: the value can be converted to the target type with minimum coercion.
+          # - `maybe`: the value can be converted to the target type with some reasonable
+          #   coercion.
+          # - `no`: the value cannot be converted to the target type.
           #
-          #   See implementation below for more details.
+          # See implementation below for more details.
           #
           #   @option state [Boolean, :strong] :strictness
           #

lib/finch_api/internal/type/enum.rb

@@ -6,15 +6,15 @@ module Type
       # @api private
       #
       # A value from among a specified list of options. OpenAPI enum values map to Ruby
-      #   values in the SDK as follows:
+      # values in the SDK as follows:
       #
-      #   1. boolean => true | false
-      #   2. integer => Integer
-      #   3. float => Float
-      #   4. string => Symbol
+      # 1. boolean => true | false
+      # 2. integer => Integer
+      # 3. float => Float
+      # 4. string => Symbol
       #
-      #   We can therefore convert string values to Symbols, but can't convert other
-      #   values safely.
+      # We can therefore convert string values to Symbols, but can't convert other
+      # values safely.
       #
       # @example
       #   # `connection_status_type` is a `FinchAPI::Models::ConnectionStatusType`
@@ -70,7 +70,7 @@ def ==(other)
         # @api private
         #
         # Unlike with primitives, `Enum` additionally validates that the value is a member
-        #   of the enum.
+        # of the enum.
         #
         # @param value [String, Symbol, Object]
         #

lib/finch_api/internal/util.rb

@@ -152,7 +152,7 @@ class << self
         # @api private
         #
         # Recursively merge one hash with another. If the values at a given key are not
-        #   both hashes, just take the new value.
+        # both hashes, just take the new value.
         #
         # @param values [Array<Object>]
         #

lib/finch_api/models/account_update_event.rb

@@ -52,7 +52,7 @@ class Data < FinchAPI::Internal::Type::BaseModel
         class AuthenticationMethod < FinchAPI::Internal::Type::BaseModel
           # @!attribute benefits_support
           #   Each benefit type and their supported features. If the benefit type is not
-          #     supported, the property will be null
+          #   supported, the property will be null
           #
           #   @return [FinchAPI::Models::HRIS::BenefitsSupport, nil]
           optional :benefits_support, -> { FinchAPI::Models::HRIS::BenefitsSupport }, nil?: true

lib/finch_api/models/base_webhook_event.rb

@@ -5,15 +5,15 @@ module Models
     class BaseWebhookEvent < FinchAPI::Internal::Type::BaseModel
       # @!attribute account_id
       #   [DEPRECATED] Unique Finch ID of the employer account used to make this
-      #     connection. Use `connection_id` instead to identify the connection associated
-      #     with this event.
+      #   connection. Use `connection_id` instead to identify the connection associated
+      #   with this event.
       #
       #   @return [String]
       required :account_id, String
 
       # @!attribute company_id
       #   [DEPRECATED] Unique Finch ID of the company for which data has been updated. Use
-      #     `connection_id` instead to identify the connection associated with this event.
+      #   `connection_id` instead to identify the connection associated with this event.
       #
       #   @return [String]
       required :company_id, String

lib/finch_api/models/connect/session_new_params.rb

@@ -42,7 +42,7 @@ class SessionNewParams < FinchAPI::Internal::Type::BaseModel
 
         # @!attribute minutes_to_expire
         #   The number of minutes until the session expires (defaults to 43,200, which is 30
-        #     days)
+        #   days)
         #
         #   @return [Float, nil]
         optional :minutes_to_expire, Float, nil?: true