Skip to content

Commit 67b0e35

Browse files
chore(internal): minor type annotation improvements
1 parent ca0d841 commit 67b0e35

File tree

8 files changed

+13
-9
lines changed

8 files changed

+13
-9
lines changed

Steepfile

+1-1
Original file line numberDiff line numberDiff line change
@@ -2,7 +2,7 @@
22

33
require "yaml"
44

5-
target :lib do
5+
target(:lib) do
66
configure_code_diagnostics(Steep::Diagnostic::Ruby.strict)
77

88
signature("sig")

lib/openai/internal/cursor_page.rb

+1-1
Original file line numberDiff line numberDiff line change
@@ -28,7 +28,7 @@ def next_page?
2828
end
2929

3030
# @raise [OpenAI::HTTP::Error]
31-
# @return [OpenAI::Internal::CursorPage]
31+
# @return [self]
3232
def next_page
3333
unless next_page?
3434
message = "No more pages available. Please check #next_page? before calling ##{__method__}"

lib/openai/internal/page.rb

+1-1
Original file line numberDiff line numberDiff line change
@@ -28,7 +28,7 @@ def next_page?
2828
end
2929

3030
# @raise [OpenAI::HTTP::Error]
31-
# @return [OpenAI::Internal::Page]
31+
# @return [self]
3232
def next_page
3333
RuntimeError.new("No more pages available.")
3434
end

lib/openai/internal/transport/base_client.rb

+4-4
Original file line numberDiff line numberDiff line change
@@ -216,9 +216,9 @@ def initialize(
216216
#
217217
# @option req [Symbol, nil] :unwrap
218218
#
219-
# @option req [Class, nil] :page
219+
# @option req [Class<OpenAI::Internal::Type::BasePage>, nil] :page
220220
#
221-
# @option req [Class, nil] :stream
221+
# @option req [Class<OpenAI::Internal::Type::BaseStream>, nil] :stream
222222
#
223223
# @option req [OpenAI::Internal::Type::Converter, Class, nil] :model
224224
#
@@ -417,9 +417,9 @@ def initialize(
417417
#
418418
# @param unwrap [Symbol, nil]
419419
#
420-
# @param page [Class, nil]
420+
# @param page [Class<OpenAI::Internal::Type::BasePage>, nil]
421421
#
422-
# @param stream [Class, nil]
422+
# @param stream [Class<OpenAI::Internal::Type::BaseStream>, nil]
423423
#
424424
# @param model [OpenAI::Internal::Type::Converter, Class, nil]
425425
#

lib/openai/internal/type/array_of.rb

+2
Original file line numberDiff line numberDiff line change
@@ -28,6 +28,8 @@ class ArrayOf
2828
# @option spec [Proc] :union
2929
#
3030
# @option spec [Boolean] :"nil?"
31+
#
32+
# @return [OpenAI::Internal::Type::ArrayOf]
3133
def self.[](...) = new(...)
3234

3335
# @api public

lib/openai/internal/type/base_model.rb

+1-1
Original file line numberDiff line numberDiff line change
@@ -389,7 +389,7 @@ def to_yaml(*a) = OpenAI::Internal::Type::Converter.dump(self.class, self).to_ya
389389

390390
# Create a new instance of a model.
391391
#
392-
# @param data [Hash{Symbol=>Object}, OpenAI::Internal::Type::BaseModel]
392+
# @param data [Hash{Symbol=>Object}, self]
393393
def initialize(data = {})
394394
case OpenAI::Internal::Util.coerce_hash(data)
395395
in Hash => coerced

lib/openai/internal/type/base_page.rb

+1-1
Original file line numberDiff line numberDiff line change
@@ -19,7 +19,7 @@ def next_page? = (raise NotImplementedError)
1919
# @api public
2020
#
2121
# @raise [OpenAI::Errors::APIError]
22-
# @return [OpenAI::Internal::Type::BasePage]
22+
# @return [self]
2323
def next_page = (raise NotImplementedError)
2424

2525
# @api public

lib/openai/internal/type/hash_of.rb

+2
Original file line numberDiff line numberDiff line change
@@ -28,6 +28,8 @@ class HashOf
2828
# @option spec [Proc] :union
2929
#
3030
# @option spec [Boolean] :"nil?"
31+
#
32+
# @return [OpenAI::Internal::Type::HashOf]
3133
def self.[](...) = new(...)
3234

3335
# @api public

0 commit comments

Comments
 (0)