Skip to content

Commit 02c3b7d

Browse files
chore: do not label modules as abstract (#22)
1 parent 879327c commit 02c3b7d

File tree

12 files changed

+20
-15
lines changed

12 files changed

+20
-15
lines changed

.rubocop.yml

Lines changed: 5 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -58,6 +58,11 @@ Layout/MultilineMethodParameterLineBreaks:
5858
Layout/SpaceInsideHashLiteralBraces:
5959
EnforcedStyle: no_space
6060

61+
# This option occasionally mangles identifier names
62+
Lint/DeprecatedConstants:
63+
Exclude:
64+
- "**/*.rbi"
65+
6166
# Fairly useful in tests for pattern assertions.
6267
Lint/EmptyInPattern:
6368
Exclude:

lib/openai/base_model.rb

Lines changed: 0 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -2,8 +2,6 @@
22

33
module OpenAI
44
# @api private
5-
#
6-
# @abstract
75
module Converter
86
# rubocop:disable Lint/UnusedMethodArgument
97

lib/openai/base_page.rb

Lines changed: 0 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,8 +1,6 @@
11
# frozen_string_literal: true
22

33
module OpenAI
4-
# @abstract
5-
#
64
# @example
75
# ```ruby
86
# if page.has_next?

lib/openai/extern.rb

Lines changed: 0 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -2,8 +2,6 @@
22

33
module OpenAI
44
# @api private
5-
#
6-
# @abstract
75
module Extern
86
end
97
end

lib/openai/request_options.rb

Lines changed: 0 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -2,8 +2,6 @@
22

33
module OpenAI
44
# @api private
5-
#
6-
# @abstract
75
module RequestParameters
86
# @!parse
97
# # Options to specify HTTP behaviour for this request.

rbi/lib/openai/base_client.rbi

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,7 @@
11
# typed: strong
22

33
module OpenAI
4+
# @api private
45
class BaseClient
56
abstract!
67

rbi/lib/openai/base_model.rbi

Lines changed: 11 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -3,8 +3,6 @@
33
module OpenAI
44
# @api private
55
module Converter
6-
abstract!
7-
86
Input = T.type_alias { T.any(OpenAI::Converter, T::Class[T.anything]) }
97

108
# @api private
@@ -78,6 +76,8 @@ module OpenAI
7876
end
7977
end
8078

79+
# @api private
80+
#
8181
# When we don't know what to expect for the value.
8282
class Unknown
8383
extend OpenAI::Converter
@@ -115,6 +115,8 @@ module OpenAI
115115
end
116116
end
117117

118+
# @api private
119+
#
118120
# Ruby has no Boolean class; this is something for models to refer to.
119121
class BooleanModel
120122
extend OpenAI::Converter
@@ -156,6 +158,8 @@ module OpenAI
156158
end
157159
end
158160

161+
# @api private
162+
#
159163
# A value from among a specified list of options. OpenAPI enum values map to Ruby
160164
# values in the SDK as follows:
161165
#
@@ -217,6 +221,7 @@ module OpenAI
217221
end
218222
end
219223

224+
# @api private
220225
class Union
221226
extend OpenAI::Converter
222227

@@ -294,6 +299,8 @@ module OpenAI
294299
end
295300
end
296301

302+
# @api private
303+
#
297304
# Array of items of a given type.
298305
class ArrayOf
299306
include OpenAI::Converter
@@ -359,6 +366,8 @@ module OpenAI
359366
end
360367
end
361368

369+
# @api private
370+
#
362371
# Hash of items of a given type.
363372
class HashOf
364373
include OpenAI::Converter

rbi/lib/openai/base_page.rbi

Lines changed: 0 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -2,8 +2,6 @@
22

33
module OpenAI
44
module BasePage
5-
abstract!
6-
75
Elem = type_member(:out)
86

97
sig { overridable.returns(T::Boolean) }

rbi/lib/openai/extern.rbi

Lines changed: 0 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -3,6 +3,5 @@
33
module OpenAI
44
# @api private
55
module Extern
6-
abstract!
76
end
87
end

rbi/lib/openai/pooled_net_requester.rbi

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,7 @@
11
# typed: strong
22

33
module OpenAI
4+
# @api private
45
class PooledNetRequester
56
RequestShape = T.type_alias do
67
{method: Symbol, url: URI::Generic, headers: T::Hash[String, String], body: T.anything, deadline: Float}

0 commit comments

Comments
 (0)