Skip to content

Commit f45cc4b

Browse files
kanutocdkanutocd
committed
let yard understand github markup
1 parent bdc636d commit f45cc4b

27 files changed

+866
-943
lines changed

‎.yardopts‎

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,5 @@
1-
--markup markdown
2-
--markup-provider kramdown
1+
--markup-provider=redcarpet
2+
--markup=markdown
33
--main README.md
44
--output-dir doc
55
--protected

‎Gemfile‎

Lines changed: 3 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -22,6 +22,8 @@ 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"
25+
gem "github-markup", "~> 5.0"
26+
gem "redcarpet", "~> 3.6"
2627
end
2728

29+

‎Gemfile.lock‎

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -14,6 +14,7 @@ GEM
1414
diff-lcs (1.6.2)
1515
docile (1.4.1)
1616
erb (5.0.1)
17+
github-markup (5.0.1)
1718
hashdiff (1.2.0)
1819
http-2 (1.1.1)
1920
httpx (1.5.1)
@@ -51,6 +52,7 @@ GEM
5152
rdoc (6.14.1)
5253
erb
5354
psych (>= 4.0.0)
55+
redcarpet (3.6.1)
5456
regexp_parser (2.10.0)
5557
reline (0.6.1)
5658
io-console (~> 0.5)
@@ -127,12 +129,14 @@ PLATFORMS
127129

128130
DEPENDENCIES
129131
csv (~> 3.3)
132+
github-markup (~> 5.0)
130133
httpx (~> 1.0)
131134
irb (~> 1.15)
132135
kramdown (~> 2.5)
133136
ostruct (~> 0.6.2)
134137
pry (~> 0.14)
135138
rake (~> 13.0)
139+
redcarpet (~> 3.6)
136140
rspec (~> 3.12)
137141
rspec_junit_formatter (~> 0.6.0)
138142
rubocop (~> 1.57)

‎README.md‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -225,7 +225,7 @@ requests = [
225225
responses = TwelvedataRuby::Client.request(requests)
226226
responses.each_with_index do |http_response, index|
227227
response = TwelvedataRuby::Response.resolve(http_response, requests[index])
228-
puts "#{requests[index].query_params[:symbol]}: #{response.parsed_body[:close]}"
228+
puts requests[index].query_params[:symbol] + ": " + response.parsed_body[:close]
229229
end
230230
```
231231

‎doc/TwelvedataRuby.html‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -410,7 +410,7 @@ <h3 class="signature " id="version-class_method">
410410
</div>
411411

412412
<div id="footer">
413-
Generated on Sun Jul 6 23:38:34 2025 by
413+
Generated on Sun Jul 6 23:59:32 2025 by
414414
<a href="https://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a>
415415
0.9.37 (ruby-3.4.2).
416416
</div>

‎doc/TwelvedataRuby/BadRequestResponseError.html‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -178,7 +178,7 @@ <h2>Constructor Details</h2>
178178
</div>
179179

180180
<div id="footer">
181-
Generated on Sun Jul 6 23:38:35 2025 by
181+
Generated on Sun Jul 6 23:59:33 2025 by
182182
<a href="https://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a>
183183
0.9.37 (ruby-3.4.2).
184184
</div>

‎doc/TwelvedataRuby/Client.html‎

Lines changed: 5 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -464,8 +464,7 @@ <h2>
464464

465465

466466

467-
<span class="summary_desc"><div class='inline'>
468-
</div></span>
467+
<span class="summary_desc"><div class='inline'></div></span>
469468

470469
</li>
471470

@@ -510,8 +509,7 @@ <h2>
510509

511510

512511

513-
<span class="summary_desc"><div class='inline'>
514-
</div></span>
512+
<span class="summary_desc"><div class='inline'></div></span>
515513

516514
</li>
517515

@@ -581,8 +579,7 @@ <h2>
581579

582580

583581

584-
<span class="summary_desc"><div class='inline'>
585-
</div></span>
582+
<span class="summary_desc"><div class='inline'></div></span>
586583

587584
</li>
588585

@@ -604,8 +601,7 @@ <h2>
604601

605602

606603

607-
<span class="summary_desc"><div class='inline'>
608-
</div></span>
604+
<span class="summary_desc"><div class='inline'></div></span>
609605

610606
</li>
611607

@@ -1967,7 +1963,7 @@ <h3 class="signature " id="respond_to_missing?-instance_method">
19671963
</div>
19681964

19691965
<div id="footer">
1970-
Generated on Sun Jul 6 23:38:35 2025 by
1966+
Generated on Sun Jul 6 23:59:33 2025 by
19711967
<a href="https://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a>
19721968
0.9.37 (ruby-3.4.2).
19731969
</div>

‎doc/TwelvedataRuby/Endpoint.html‎

Lines changed: 11 additions & 22 deletions
Original file line numberDiff line numberDiff line change
@@ -334,8 +334,7 @@ <h2>
334334

335335

336336

337-
<span class="summary_desc"><div class='inline'>
338-
</div></span>
337+
<span class="summary_desc"><div class='inline'></div></span>
339338

340339
</li>
341340

@@ -481,8 +480,7 @@ <h2>
481480

482481

483482

484-
<span class="summary_desc"><div class='inline'>
485-
</div></span>
483+
<span class="summary_desc"><div class='inline'></div></span>
486484

487485
</li>
488486

@@ -504,8 +502,7 @@ <h2>
504502

505503

506504

507-
<span class="summary_desc"><div class='inline'>
508-
</div></span>
505+
<span class="summary_desc"><div class='inline'></div></span>
509506

510507
</li>
511508

@@ -598,8 +595,7 @@ <h2>
598595

599596

600597

601-
<span class="summary_desc"><div class='inline'>
602-
</div></span>
598+
<span class="summary_desc"><div class='inline'></div></span>
603599

604600
</li>
605601

@@ -667,8 +663,7 @@ <h2>
667663

668664

669665

670-
<span class="summary_desc"><div class='inline'>
671-
</div></span>
666+
<span class="summary_desc"><div class='inline'></div></span>
672667

673668
</li>
674669

@@ -736,8 +731,7 @@ <h2>
736731

737732

738733

739-
<span class="summary_desc"><div class='inline'>
740-
</div></span>
734+
<span class="summary_desc"><div class='inline'></div></span>
741735

742736
</li>
743737

@@ -828,8 +822,7 @@ <h2>
828822

829823

830824

831-
<span class="summary_desc"><div class='inline'>
832-
</div></span>
825+
<span class="summary_desc"><div class='inline'></div></span>
833826

834827
</li>
835828

@@ -851,8 +844,7 @@ <h2>
851844

852845

853846

854-
<span class="summary_desc"><div class='inline'>
855-
</div></span>
847+
<span class="summary_desc"><div class='inline'></div></span>
856848

857849
</li>
858850

@@ -874,8 +866,7 @@ <h2>
874866

875867

876868

877-
<span class="summary_desc"><div class='inline'>
878-
</div></span>
869+
<span class="summary_desc"><div class='inline'></div></span>
879870

880871
</li>
881872

@@ -897,8 +888,7 @@ <h2>
897888

898889

899890

900-
<span class="summary_desc"><div class='inline'>
901-
</div></span>
891+
<span class="summary_desc"><div class='inline'></div></span>
902892

903893
</li>
904894

@@ -1512,7 +1502,6 @@ <h3 class="signature " id="csv_format_with_filename?-instance_method">
15121502
<div class="discussion">
15131503

15141504

1515-
15161505
</div>
15171506
</div>
15181507
<div class="tags">
@@ -2338,7 +2327,7 @@ <h3 class="signature " id="validate_required_parameters-instance_method">
23382327
</div>
23392328

23402329
<div id="footer">
2341-
Generated on Sun Jul 6 23:38:35 2025 by
2330+
Generated on Sun Jul 6 23:59:33 2025 by
23422331
<a href="https://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a>
23432332
0.9.37 (ruby-3.4.2).
23442333
</div>

‎doc/TwelvedataRuby/EndpointError.html‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -248,7 +248,7 @@ <h3 class="signature first" id="initialize-instance_method">
248248
</div>
249249

250250
<div id="footer">
251-
Generated on Sun Jul 6 23:38:35 2025 by
251+
Generated on Sun Jul 6 23:59:32 2025 by
252252
<a href="https://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a>
253253
0.9.37 (ruby-3.4.2).
254254
</div>

‎doc/TwelvedataRuby/EndpointNameError.html‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -167,7 +167,7 @@ <h2>Constructor Details</h2>
167167
</div>
168168

169169
<div id="footer">
170-
Generated on Sun Jul 6 23:38:35 2025 by
170+
Generated on Sun Jul 6 23:59:32 2025 by
171171
<a href="https://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a>
172172
0.9.37 (ruby-3.4.2).
173173
</div>

0 commit comments

Comments
 (0)