Skip to content

Commit 155d0cd

Browse files
toshimarutoshimaru
authored
Update docs (2023/11/16) (#133)
* chore: Use constant to make it easy to switch the branch * docs: update doc This doc generation includes the following changes: - toshimaru/sdoc#6 - toshimaru/sdoc#7
1 parent 60d7346 commit 155d0cd

File tree

919 files changed

+14334
-16348
lines changed

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

919 files changed

+14334
-16348
lines changed

‎Rakefile

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -6,6 +6,7 @@ require 'bundler'
66
SOURCE_DIR = 'src'
77
INDEX_HTML = 'files/railties/RDOC_MAIN_rdoc.html'
88
NEW_INDEX_HTML = 'files/railties/RDOC_MAIN_md.html'
9+
MY_SDOC_BRANCH = 'main'
910

1011
desc 'Generate documentation for default Rails version and build Jekyll site'
1112
task build: :switch_default_rails do
@@ -64,7 +65,7 @@ def generate_rails_rdoc
6465

6566
# Replace sdoc gem with my forked one
6667
gemfile = File.read('Gemfile')
67-
gemfile.gsub!(/"sdoc".*$/, '"sdoc", github: "toshimaru/sdoc", branch: "main"')
68+
gemfile.gsub!(/"sdoc".*$/, %("sdoc", github: "toshimaru/sdoc", branch: "#{MY_SDOC_BRANCH}"))
6869
File.write('Gemfile', gemfile)
6970

7071
sh 'bundle install && bundle update sdoc'

‎src/classes/AbstractController/Base.html

Lines changed: 33 additions & 33 deletions
Original file line numberDiff line numberDiff line change
@@ -183,15 +183,15 @@ <h3 id="method-c-abstract-21">
183183

184184
<details class="method__source">
185185
<summary>
186-
<span class="label">Source code</span>
186+
<span class="label">📝 Source code</span>
187187
</summary>
188188

189189
<pre><code class="ruby"># File actionpack/lib/abstract_controller/base.rb, line 57
190190
def abstract!
191191
@abstract = true
192192
end</code></pre>
193193

194-
<a href="https://github.com/rails/rails/blob/d39db5d1891f7509cde2efc425c9d69bbb77e670/actionpack/lib/abstract_controller/base.rb#L57" target="_blank" class="github_url">See on GitHub</a>
194+
<a href="https://github.com/rails/rails/blob/d39db5d1891f7509cde2efc425c9d69bbb77e670/actionpack/lib/abstract_controller/base.rb#L57" target="_blank" class="github_url">🔎 See on GitHub</a>
195195

196196
</details>
197197

@@ -223,7 +223,7 @@ <h4 id="method-c-action_methods-label-Returns">Returns</h4>
223223

224224
<details class="method__source">
225225
<summary>
226-
<span class="label">Source code</span>
226+
<span class="label">📝 Source code</span>
227227
</summary>
228228

229229
<pre><code class="ruby"># File actionpack/lib/abstract_controller/base.rb, line 96
@@ -234,12 +234,12 @@ <h4 id="method-c-action_methods-label-Returns">Returns</h4>
234234
methods = public_instance_methods(true) - internal_methods
235235
# Be sure to include shadowed public instance methods of this class.
236236
methods.concat(public_instance_methods(false))
237-
methods.map!(&:to_s)
237+
methods.map!(&amp;:to_s)
238238
methods.to_set
239239
end
240240
end</code></pre>
241241

242-
<a href="https://github.com/rails/rails/blob/d39db5d1891f7509cde2efc425c9d69bbb77e670/actionpack/lib/abstract_controller/base.rb#L96" target="_blank" class="github_url">See on GitHub</a>
242+
<a href="https://github.com/rails/rails/blob/d39db5d1891f7509cde2efc425c9d69bbb77e670/actionpack/lib/abstract_controller/base.rb#L96" target="_blank" class="github_url">🔎 See on GitHub</a>
243243

244244
</details>
245245

@@ -266,15 +266,15 @@ <h3 id="method-c-clear_action_methods-21">
266266

267267
<details class="method__source">
268268
<summary>
269-
<span class="label">Source code</span>
269+
<span class="label">📝 Source code</span>
270270
</summary>
271271

272272
<pre><code class="ruby"># File actionpack/lib/abstract_controller/base.rb, line 111
273273
def clear_action_methods!
274274
@action_methods = nil
275275
end</code></pre>
276276

277-
<a href="https://github.com/rails/rails/blob/d39db5d1891f7509cde2efc425c9d69bbb77e670/actionpack/lib/abstract_controller/base.rb#L111" target="_blank" class="github_url">See on GitHub</a>
277+
<a href="https://github.com/rails/rails/blob/d39db5d1891f7509cde2efc425c9d69bbb77e670/actionpack/lib/abstract_controller/base.rb#L111" target="_blank" class="github_url">🔎 See on GitHub</a>
278278

279279
</details>
280280

@@ -313,15 +313,15 @@ <h4 id="method-c-controller_path-label-Returns">Returns</h4>
313313

314314
<details class="method__source">
315315
<summary>
316-
<span class="label">Source code</span>
316+
<span class="label">📝 Source code</span>
317317
</summary>
318318

319319
<pre><code class="ruby"># File actionpack/lib/abstract_controller/base.rb, line 125
320320
def controller_path
321-
@controller_path ||= name.delete_suffix("Controller").underscore unless anonymous?
321+
@controller_path ||= name.delete_suffix(&quot;Controller&quot;).underscore unless anonymous?
322322
end</code></pre>
323323

324-
<a href="https://github.com/rails/rails/blob/d39db5d1891f7509cde2efc425c9d69bbb77e670/actionpack/lib/abstract_controller/base.rb#L125" target="_blank" class="github_url">See on GitHub</a>
324+
<a href="https://github.com/rails/rails/blob/d39db5d1891f7509cde2efc425c9d69bbb77e670/actionpack/lib/abstract_controller/base.rb#L125" target="_blank" class="github_url">🔎 See on GitHub</a>
325325

326326
</details>
327327

@@ -348,7 +348,7 @@ <h3 id="method-c-internal_methods">
348348

349349
<details class="method__source">
350350
<summary>
351-
<span class="label">Source code</span>
351+
<span class="label">📝 Source code</span>
352352
</summary>
353353

354354
<pre><code class="ruby"># File actionpack/lib/abstract_controller/base.rb, line 76
@@ -364,7 +364,7 @@ <h3 id="method-c-internal_methods">
364364
controller.public_instance_methods(true) - methods
365365
end</code></pre>
366366

367-
<a href="https://github.com/rails/rails/blob/d39db5d1891f7509cde2efc425c9d69bbb77e670/actionpack/lib/abstract_controller/base.rb#L76" target="_blank" class="github_url">See on GitHub</a>
367+
<a href="https://github.com/rails/rails/blob/d39db5d1891f7509cde2efc425c9d69bbb77e670/actionpack/lib/abstract_controller/base.rb#L76" target="_blank" class="github_url">🔎 See on GitHub</a>
368368

369369
</details>
370370

@@ -391,7 +391,7 @@ <h3 id="method-c-method_added">
391391

392392
<details class="method__source">
393393
<summary>
394-
<span class="label">Source code</span>
394+
<span class="label">📝 Source code</span>
395395
</summary>
396396

397397
<pre><code class="ruby"># File actionpack/lib/abstract_controller/base.rb, line 130
@@ -400,7 +400,7 @@ <h3 id="method-c-method_added">
400400
clear_action_methods!
401401
end</code></pre>
402402

403-
<a href="https://github.com/rails/rails/blob/d39db5d1891f7509cde2efc425c9d69bbb77e670/actionpack/lib/abstract_controller/base.rb#L130" target="_blank" class="github_url">See on GitHub</a>
403+
<a href="https://github.com/rails/rails/blob/d39db5d1891f7509cde2efc425c9d69bbb77e670/actionpack/lib/abstract_controller/base.rb#L130" target="_blank" class="github_url">🔎 See on GitHub</a>
404404

405405
</details>
406406

@@ -427,15 +427,15 @@ <h3 id="method-c-supports_path-3F">
427427

428428
<details class="method__source">
429429
<summary>
430-
<span class="label">Source code</span>
430+
<span class="label">📝 Source code</span>
431431
</summary>
432432

433433
<pre><code class="ruby"># File actionpack/lib/abstract_controller/base.rb, line 199
434434
def self.supports_path?
435435
true
436436
end</code></pre>
437437

438-
<a href="https://github.com/rails/rails/blob/d39db5d1891f7509cde2efc425c9d69bbb77e670/actionpack/lib/abstract_controller/base.rb#L199" target="_blank" class="github_url">See on GitHub</a>
438+
<a href="https://github.com/rails/rails/blob/d39db5d1891f7509cde2efc425c9d69bbb77e670/actionpack/lib/abstract_controller/base.rb#L199" target="_blank" class="github_url">🔎 See on GitHub</a>
439439

440440
</details>
441441

@@ -466,15 +466,15 @@ <h3 id="method-i-action_methods">
466466

467467
<details class="method__source">
468468
<summary>
469-
<span class="label">Source code</span>
469+
<span class="label">📝 Source code</span>
470470
</summary>
471471

472472
<pre><code class="ruby"># File actionpack/lib/abstract_controller/base.rb, line 170
473473
def action_methods
474474
self.class.action_methods
475475
end</code></pre>
476476

477-
<a href="https://github.com/rails/rails/blob/d39db5d1891f7509cde2efc425c9d69bbb77e670/actionpack/lib/abstract_controller/base.rb#L170" target="_blank" class="github_url">See on GitHub</a>
477+
<a href="https://github.com/rails/rails/blob/d39db5d1891f7509cde2efc425c9d69bbb77e670/actionpack/lib/abstract_controller/base.rb#L170" target="_blank" class="github_url">🔎 See on GitHub</a>
478478

479479
</details>
480480

@@ -501,14 +501,14 @@ <h3 id="method-i-action_name">
501501

502502
<details class="method__source">
503503
<summary>
504-
<span class="label">Source code</span>
504+
<span class="label">📝 Source code</span>
505505
</summary>
506506

507507
<pre><code class="ruby"># File actionpack/lib/abstract_controller/base.rb, line 42
508508
attr_internal :action_name
509509
</code></pre>
510510

511-
<a href="https://github.com/rails/rails/blob/d39db5d1891f7509cde2efc425c9d69bbb77e670/actionpack/lib/abstract_controller/base.rb#L42" target="_blank" class="github_url">See on GitHub</a>
511+
<a href="https://github.com/rails/rails/blob/d39db5d1891f7509cde2efc425c9d69bbb77e670/actionpack/lib/abstract_controller/base.rb#L42" target="_blank" class="github_url">🔎 See on GitHub</a>
512512

513513
</details>
514514

@@ -542,15 +542,15 @@ <h4 id="method-i-available_action-3F-label-Parameters">Parameters</h4>
542542

543543
<details class="method__source">
544544
<summary>
545-
<span class="label">Source code</span>
545+
<span class="label">📝 Source code</span>
546546
</summary>
547547

548548
<pre><code class="ruby"># File actionpack/lib/abstract_controller/base.rb, line 184
549549
def available_action?(action_name)
550550
_find_action_name(action_name)
551551
end</code></pre>
552552

553-
<a href="https://github.com/rails/rails/blob/d39db5d1891f7509cde2efc425c9d69bbb77e670/actionpack/lib/abstract_controller/base.rb#L184" target="_blank" class="github_url">See on GitHub</a>
553+
<a href="https://github.com/rails/rails/blob/d39db5d1891f7509cde2efc425c9d69bbb77e670/actionpack/lib/abstract_controller/base.rb#L184" target="_blank" class="github_url">🔎 See on GitHub</a>
554554

555555
</details>
556556

@@ -577,15 +577,15 @@ <h3 id="method-i-controller_path">
577577

578578
<details class="method__source">
579579
<summary>
580-
<span class="label">Source code</span>
580+
<span class="label">📝 Source code</span>
581581
</summary>
582582

583583
<pre><code class="ruby"># File actionpack/lib/abstract_controller/base.rb, line 165
584584
def controller_path
585585
self.class.controller_path
586586
end</code></pre>
587587

588-
<a href="https://github.com/rails/rails/blob/d39db5d1891f7509cde2efc425c9d69bbb77e670/actionpack/lib/abstract_controller/base.rb#L165" target="_blank" class="github_url">See on GitHub</a>
588+
<a href="https://github.com/rails/rails/blob/d39db5d1891f7509cde2efc425c9d69bbb77e670/actionpack/lib/abstract_controller/base.rb#L165" target="_blank" class="github_url">🔎 See on GitHub</a>
589589

590590
</details>
591591

@@ -612,14 +612,14 @@ <h3 id="method-i-formats">
612612

613613
<details class="method__source">
614614
<summary>
615-
<span class="label">Source code</span>
615+
<span class="label">📝 Source code</span>
616616
</summary>
617617

618618
<pre><code class="ruby"># File actionpack/lib/abstract_controller/base.rb, line 46
619619
attr_internal :formats
620620
</code></pre>
621621

622-
<a href="https://github.com/rails/rails/blob/d39db5d1891f7509cde2efc425c9d69bbb77e670/actionpack/lib/abstract_controller/base.rb#L46" target="_blank" class="github_url">See on GitHub</a>
622+
<a href="https://github.com/rails/rails/blob/d39db5d1891f7509cde2efc425c9d69bbb77e670/actionpack/lib/abstract_controller/base.rb#L46" target="_blank" class="github_url">🔎 See on GitHub</a>
623623

624624
</details>
625625

@@ -646,15 +646,15 @@ <h3 id="method-i-performed-3F">
646646

647647
<details class="method__source">
648648
<summary>
649-
<span class="label">Source code</span>
649+
<span class="label">📝 Source code</span>
650650
</summary>
651651

652652
<pre><code class="ruby"># File actionpack/lib/abstract_controller/base.rb, line 191
653653
def performed?
654654
response_body
655655
end</code></pre>
656656

657-
<a href="https://github.com/rails/rails/blob/d39db5d1891f7509cde2efc425c9d69bbb77e670/actionpack/lib/abstract_controller/base.rb#L191" target="_blank" class="github_url">See on GitHub</a>
657+
<a href="https://github.com/rails/rails/blob/d39db5d1891f7509cde2efc425c9d69bbb77e670/actionpack/lib/abstract_controller/base.rb#L191" target="_blank" class="github_url">🔎 See on GitHub</a>
658658

659659
</details>
660660

@@ -688,23 +688,23 @@ <h4 id="method-i-process-label-Returns">Returns</h4>
688688

689689
<details class="method__source">
690690
<summary>
691-
<span class="label">Source code</span>
691+
<span class="label">📝 Source code</span>
692692
</summary>
693693

694694
<pre><code class="ruby"># File actionpack/lib/abstract_controller/base.rb, line 151
695695
def process(action, *args)
696696
@_action_name = action.to_s
697697

698698
unless action_name = _find_action_name(@_action_name)
699-
raise ActionNotFound.new("The action '#{action}' could not be found for #{self.class.name}", self, action)
699+
raise ActionNotFound.new(&quot;The action &#39;#{action}&#39; could not be found for #{self.class.name}&quot;, self, action)
700700
end
701701

702702
@_response_body = nil
703703

704704
process_action(action_name, *args)
705705
end</code></pre>
706706

707-
<a href="https://github.com/rails/rails/blob/d39db5d1891f7509cde2efc425c9d69bbb77e670/actionpack/lib/abstract_controller/base.rb#L151" target="_blank" class="github_url">See on GitHub</a>
707+
<a href="https://github.com/rails/rails/blob/d39db5d1891f7509cde2efc425c9d69bbb77e670/actionpack/lib/abstract_controller/base.rb#L151" target="_blank" class="github_url">🔎 See on GitHub</a>
708708

709709
</details>
710710

@@ -731,14 +731,14 @@ <h3 id="method-i-response_body">
731731

732732
<details class="method__source">
733733
<summary>
734-
<span class="label">Source code</span>
734+
<span class="label">📝 Source code</span>
735735
</summary>
736736

737737
<pre><code class="ruby"># File actionpack/lib/abstract_controller/base.rb, line 38
738738
attr_internal :response_body
739739
</code></pre>
740740

741-
<a href="https://github.com/rails/rails/blob/d39db5d1891f7509cde2efc425c9d69bbb77e670/actionpack/lib/abstract_controller/base.rb#L38" target="_blank" class="github_url">See on GitHub</a>
741+
<a href="https://github.com/rails/rails/blob/d39db5d1891f7509cde2efc425c9d69bbb77e670/actionpack/lib/abstract_controller/base.rb#L38" target="_blank" class="github_url">🔎 See on GitHub</a>
742742

743743
</details>
744744

‎src/classes/AbstractController/Caching.html

Lines changed: 7 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -123,15 +123,15 @@ <h3 id="method-i-view_cache_dependencies">
123123

124124
<details class="method__source">
125125
<summary>
126-
<span class="label">Source code</span>
126+
<span class="label">📝 Source code</span>
127127
</summary>
128128

129129
<pre><code class="ruby"># File actionpack/lib/abstract_controller/caching.rb, line 52
130130
def view_cache_dependencies
131-
self.class._view_cache_dependencies.filter_map { |dep| instance_exec(&dep) }
131+
self.class._view_cache_dependencies.filter_map { |dep| instance_exec(&amp;dep) }
132132
end</code></pre>
133133

134-
<a href="https://github.com/rails/rails/blob/d39db5d1891f7509cde2efc425c9d69bbb77e670/actionpack/lib/abstract_controller/caching.rb#L52" target="_blank" class="github_url">See on GitHub</a>
134+
<a href="https://github.com/rails/rails/blob/d39db5d1891f7509cde2efc425c9d69bbb77e670/actionpack/lib/abstract_controller/caching.rb#L52" target="_blank" class="github_url">🔎 See on GitHub</a>
135135

136136
</details>
137137

@@ -161,19 +161,19 @@ <h3 id="method-i-cache">
161161

162162
<details class="method__source">
163163
<summary>
164-
<span class="label">Source code</span>
164+
<span class="label">📝 Source code</span>
165165
</summary>
166166

167167
<pre><code class="ruby"># File actionpack/lib/abstract_controller/caching.rb, line 58
168-
def cache(key, options = {}, &block) # :doc:
168+
def cache(key, options = {}, &amp;block) # :doc:
169169
if cache_configured?
170-
cache_store.fetch(ActiveSupport::Cache.expand_cache_key(key, :controller), options, &block)
170+
cache_store.fetch(ActiveSupport::Cache.expand_cache_key(key, :controller), options, &amp;block)
171171
else
172172
yield
173173
end
174174
end</code></pre>
175175

176-
<a href="https://github.com/rails/rails/blob/d39db5d1891f7509cde2efc425c9d69bbb77e670/actionpack/lib/abstract_controller/caching.rb#L58" target="_blank" class="github_url">See on GitHub</a>
176+
<a href="https://github.com/rails/rails/blob/d39db5d1891f7509cde2efc425c9d69bbb77e670/actionpack/lib/abstract_controller/caching.rb#L58" target="_blank" class="github_url">🔎 See on GitHub</a>
177177

178178
</details>
179179

‎src/classes/AbstractController/Caching/ClassMethods.html

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -78,15 +78,15 @@ <h3 id="method-i-view_cache_dependency">
7878

7979
<details class="method__source">
8080
<summary>
81-
<span class="label">Source code</span>
81+
<span class="label">📝 Source code</span>
8282
</summary>
8383

8484
<pre><code class="ruby"># File actionpack/lib/abstract_controller/caching.rb, line 47
85-
def view_cache_dependency(&dependency)
85+
def view_cache_dependency(&amp;dependency)
8686
self._view_cache_dependencies += [dependency]
8787
end</code></pre>
8888

89-
<a href="https://github.com/rails/rails/blob/d39db5d1891f7509cde2efc425c9d69bbb77e670/actionpack/lib/abstract_controller/caching.rb#L47" target="_blank" class="github_url">See on GitHub</a>
89+
<a href="https://github.com/rails/rails/blob/d39db5d1891f7509cde2efc425c9d69bbb77e670/actionpack/lib/abstract_controller/caching.rb#L47" target="_blank" class="github_url">🔎 See on GitHub</a>
9090

9191
</details>
9292

0 commit comments

Comments
 (0)