Skip to content

Commit bdc636d

Browse files
committed
fix api docs
1 parent cc145d3 commit bdc636d

34 files changed

+7857
-2258
lines changed

.yardopts

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -6,7 +6,7 @@
66
--private
77
--title "TwelvedataRuby Documentation"
88
--readme README.md
9-
--files CHANGELOG.md,LICENSE.txt
9+
--files CHANGELOG.md,LICENSE
1010
lib/**/*.rb
1111
-
1212
README.md

Gemfile

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -22,4 +22,6 @@ group :development, :test do
2222
gem "irb", "~> 1.15"
2323
gem "ostruct", "~> 0.6.2"
2424
gem "rspec_junit_formatter", "~> 0.6.0"
25+
gem "kramdown", "~> 2.5"
2526
end
27+

Gemfile.lock

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -24,6 +24,8 @@ GEM
2424
rdoc (>= 4.0.0)
2525
reline (>= 0.4.2)
2626
json (2.12.2)
27+
kramdown (2.5.1)
28+
rexml (>= 3.3.9)
2729
language_server-protocol (3.17.0.5)
2830
lint_roller (1.1.0)
2931
method_source (1.1.0)
@@ -127,6 +129,7 @@ DEPENDENCIES
127129
csv (~> 3.3)
128130
httpx (~> 1.0)
129131
irb (~> 1.15)
132+
kramdown (~> 2.5)
130133
ostruct (~> 0.6.2)
131134
pry (~> 0.14)
132135
rake (~> 13.0)

doc/TwelvedataRuby.html

Lines changed: 138 additions & 71 deletions
Large diffs are not rendered by default.

doc/TwelvedataRuby/BadRequestResponseError.html

Lines changed: 20 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -6,7 +6,7 @@
66
<title>
77
Exception: TwelvedataRuby::BadRequestResponseError
88

9-
&mdash; Documentation by YARD 0.9.26
9+
&mdash; TwelvedataRuby Documentation
1010

1111
</title>
1212

@@ -105,33 +105,43 @@
105105

106106
</div>
107107

108+
<h2>Overview</h2><div class="docstring">
109+
<div class="discussion">
110+
<p>Specific API error classes</p>
108111

109112

113+
</div>
114+
</div>
115+
<div class="tags">
116+
117+
118+
</div>
119+
110120

111121
<h2>Constant Summary</h2>
112122

113123
<h3 class="inherited">Constants inherited
114124
from <span class='object_link'><a href="ResponseError.html" title="TwelvedataRuby::ResponseError (class)">ResponseError</a></span></h3>
115-
<p class="inherited"><span class='object_link'><a href="ResponseError.html#API_ERROR_CODES_MAP-constant" title="TwelvedataRuby::ResponseError::API_ERROR_CODES_MAP (constant)">ResponseError::API_ERROR_CODES_MAP</a></span>, <span class='object_link'><a href="ResponseError.html#HTTP_ERROR_CODES_MAP-constant" title="TwelvedataRuby::ResponseError::HTTP_ERROR_CODES_MAP (constant)">ResponseError::HTTP_ERROR_CODES_MAP</a></span></p>
125+
<p class="inherited"><span class='object_link'><a href="ResponseError.html#API_ERROR_CODES-constant" title="TwelvedataRuby::ResponseError::API_ERROR_CODES (constant)">ResponseError::API_ERROR_CODES</a></span>, <span class='object_link'><a href="ResponseError.html#HTTP_ERROR_CODES-constant" title="TwelvedataRuby::ResponseError::HTTP_ERROR_CODES (constant)">ResponseError::HTTP_ERROR_CODES</a></span></p>
116126

117127

118128

119129
<h3 class="inherited">Constants inherited
120130
from <span class='object_link'><a href="Error.html" title="TwelvedataRuby::Error (class)">Error</a></span></h3>
121-
<p class="inherited"><span class='object_link'><a href="Error.html#DEFAULT_MSGS-constant" title="TwelvedataRuby::Error::DEFAULT_MSGS (constant)">Error::DEFAULT_MSGS</a></span></p>
131+
<p class="inherited"><span class='object_link'><a href="Error.html#DEFAULT_MESSAGES-constant" title="TwelvedataRuby::Error::DEFAULT_MESSAGES (constant)">Error::DEFAULT_MESSAGES</a></span></p>
122132

123133

124134

125135

126136
<h2>Instance Attribute Summary</h2>
127137

128138
<h3 class="inherited">Attributes inherited from <span class='object_link'><a href="ResponseError.html" title="TwelvedataRuby::ResponseError (class)">ResponseError</a></span></h3>
129-
<p class="inherited"><span class='object_link'><a href="ResponseError.html#code-instance_method" title="TwelvedataRuby::ResponseError#code (method)">#code</a></span>, <span class='object_link'><a href="ResponseError.html#json-instance_method" title="TwelvedataRuby::ResponseError#json (method)">#json</a></span>, <span class='object_link'><a href="ResponseError.html#request-instance_method" title="TwelvedataRuby::ResponseError#request (method)">#request</a></span></p>
139+
<p class="inherited"><span class='object_link'><a href="ResponseError.html#json_data-instance_method" title="TwelvedataRuby::ResponseError#json_data (method)">#json_data</a></span>, <span class='object_link'><a href="ResponseError.html#request-instance_method" title="TwelvedataRuby::ResponseError#request (method)">#request</a></span>, <span class='object_link'><a href="ResponseError.html#status_code-instance_method" title="TwelvedataRuby::ResponseError#status_code (method)">#status_code</a></span></p>
130140

131141

132142

133143
<h3 class="inherited">Attributes inherited from <span class='object_link'><a href="Error.html" title="TwelvedataRuby::Error (class)">Error</a></span></h3>
134-
<p class="inherited"><span class='object_link'><a href="Error.html#attrs-instance_method" title="TwelvedataRuby::Error#attrs (method)">#attrs</a></span></p>
144+
<p class="inherited"><span class='object_link'><a href="Error.html#attributes-instance_method" title="TwelvedataRuby::Error#attributes (method)">#attributes</a></span>, <span class='object_link'><a href="Error.html#original_error-instance_method" title="TwelvedataRuby::Error#original_error (method)">#original_error</a></span></p>
135145

136146

137147

@@ -144,7 +154,7 @@ <h3 class="inherited">Attributes inherited from <span class='object_link'><a hre
144154
<h2>Method Summary</h2>
145155

146156
<h3 class="inherited">Methods inherited from <span class='object_link'><a href="ResponseError.html" title="TwelvedataRuby::ResponseError (class)">ResponseError</a></span></h3>
147-
<p class="inherited"><span class='object_link'><a href="ResponseError.html#error_code_klass-class_method" title="TwelvedataRuby::ResponseError.error_code_klass (method)">error_code_klass</a></span>, <span class='object_link'><a href="ResponseError.html#initialize-instance_method" title="TwelvedataRuby::ResponseError#initialize (method)">#initialize</a></span></p>
157+
<p class="inherited"><span class='object_link'><a href="ResponseError.html#error_class_for_code-class_method" title="TwelvedataRuby::ResponseError.error_class_for_code (method)">error_class_for_code</a></span>, <span class='object_link'><a href="ResponseError.html#initialize-instance_method" title="TwelvedataRuby::ResponseError#initialize (method)">#initialize</a></span></p>
148158

149159

150160

@@ -155,7 +165,7 @@ <h3 class="inherited">Methods inherited from <span class='object_link'><a href="
155165

156166

157167
<h3 class="inherited">Methods inherited from <span class='object_link'><a href="Error.html" title="TwelvedataRuby::Error (class)">Error</a></span></h3>
158-
<p class="inherited"><span class='object_link'><a href="Error.html#initialize-instance_method" title="TwelvedataRuby::Error#initialize (method)">#initialize</a></span></p>
168+
<p class="inherited"><span class='object_link'><a href="Error.html#format_default_message-instance_method" title="TwelvedataRuby::Error#format_default_message (method)">#format_default_message</a></span>, <span class='object_link'><a href="Error.html#initialize-instance_method" title="TwelvedataRuby::Error#initialize (method)">#initialize</a></span></p>
159169

160170
<div id="constructor_details" class="method_details_list">
161171
<h2>Constructor Details</h2>
@@ -168,9 +178,9 @@ <h2>Constructor Details</h2>
168178
</div>
169179

170180
<div id="footer">
171-
Generated on Fri Jul 16 20:51:24 2021 by
172-
<a href="http://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a>
173-
0.9.26 (ruby-3.0.1).
181+
Generated on Sun Jul 6 23:38:35 2025 by
182+
<a href="https://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a>
183+
0.9.37 (ruby-3.4.2).
174184
</div>
175185

176186
</div>

0 commit comments

Comments
 (0)