Skip to content

Commit 1d9e350

Browse files
authored
Rebuild doc for Rails 7.1 & Rails 7.2 (railsdoc#186)
* build: Docs for Rails 7.1 * build: Dcos for Rails 7.2
1 parent 662fc3a commit 1d9e350

File tree

511 files changed

+2006
-2006
lines changed

Some content is hidden

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

511 files changed

+2006
-2006
lines changed

src/7.1/classes/AbstractController/Base.html

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -300,7 +300,7 @@ <h3 id="method-c-controller_path">
300300

301301
<h4 id="method-c-controller_path-label-Returns">Returns</h4>
302302
<ul><li>
303-
<p><code>String</code></p>
303+
<p><a href="../String.html"><code>String</code></a></p>
304304
</li></ul>
305305
</div>
306306

@@ -415,7 +415,7 @@ <h3 id="method-c-supports_path-3F">
415415

416416

417417
<div class="description">
418-
<p>Returns true if the given controller is capable of rendering a path. A subclass of <code>AbstractController::Base</code> may return false. An Email controller for example does not support paths, only full URLs.</p>
418+
<p>Returns true if the given controller is capable of rendering a path. A subclass of <a href="Base.html"><code>AbstractController::Base</code></a> may return false. An Email controller for example does not support paths, only full URLs.</p>
419419
</div>
420420

421421

@@ -529,7 +529,7 @@ <h3 id="method-i-available_action-3F">
529529

530530
<h4 id="method-i-available_action-3F-label-Parameters">Parameters</h4>
531531
<ul><li>
532-
<p><code>action_name</code> - The name of an action to be tested</p>
532+
<p><a href="Base.html#method-i-action_name"><code>action_name</code></a> - The name of an action to be tested</p>
533533
</li></ul>
534534
</div>
535535

src/7.1/classes/AbstractController/Caching/Fragments.html

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -108,7 +108,7 @@ <h3 id="method-i-combined_fragment_cache_key">
108108

109109

110110
<div class="description">
111-
<p>Given a key (as described in <code>expire_fragment</code>), returns a key array suitable for use in reading, writing, or expiring a cached fragment. All keys begin with <code>:views</code>, followed by <code>ENV[&quot;RAILS_CACHE_ID&quot;]</code> or <code>ENV[&quot;RAILS_APP_VERSION&quot;]</code> if set, followed by any controller-wide key prefix values, ending with the specified <code>key</code> value.</p>
111+
<p>Given a key (as described in <a href="Fragments.html#method-i-expire_fragment"><code>expire_fragment</code></a>), returns a key array suitable for use in reading, writing, or expiring a cached fragment. All keys begin with <code>:views</code>, followed by <code>ENV[&quot;RAILS_CACHE_ID&quot;]</code> or <code>ENV[&quot;RAILS_APP_VERSION&quot;]</code> if set, followed by any controller-wide key prefix values, ending with the specified <code>key</code> value.</p>
112112
</div>
113113

114114

@@ -204,7 +204,7 @@ <h3 id="method-i-fragment_exist-3F">
204204

205205

206206
<div class="description">
207-
<p>Check if a cached fragment from the location signified by <code>key</code> exists (see <code>expire_fragment</code> for acceptable formats).</p>
207+
<p>Check if a cached fragment from the location signified by <code>key</code> exists (see <a href="Fragments.html#method-i-expire_fragment"><code>expire_fragment</code></a> for acceptable formats).</p>
208208
</div>
209209

210210

@@ -244,7 +244,7 @@ <h3 id="method-i-read_fragment">
244244

245245

246246
<div class="description">
247-
<p>Reads a cached fragment from the location signified by <code>key</code> (see <code>expire_fragment</code> for acceptable formats).</p>
247+
<p>Reads a cached fragment from the location signified by <code>key</code> (see <a href="Fragments.html#method-i-expire_fragment"><code>expire_fragment</code></a> for acceptable formats).</p>
248248
</div>
249249

250250

@@ -285,7 +285,7 @@ <h3 id="method-i-write_fragment">
285285

286286

287287
<div class="description">
288-
<p>Writes <code>content</code> to the location signified by <code>key</code> (see <code>expire_fragment</code> for acceptable formats).</p>
288+
<p>Writes <code>content</code> to the location signified by <code>key</code> (see <a href="Fragments.html#method-i-expire_fragment"><code>expire_fragment</code></a> for acceptable formats).</p>
289289
</div>
290290

291291

src/7.1/classes/AbstractController/Rendering.html

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -123,7 +123,7 @@ <h3 id="method-i-render">
123123
<div class="description">
124124
<p>Normalizes arguments and options, and then delegates to <a href="Rendering.html#method-i-render_to_body"><code>render_to_body</code></a> and sticks the result in <code>self.response_body</code>.</p>
125125

126-
<p>Supported options depend on the underlying <code>render_to_body</code> implementation.</p>
126+
<p>Supported options depend on the underlying <a href="Rendering.html#method-i-render_to_body"><code>render_to_body</code></a> implementation.</p>
127127
</div>
128128

129129

src/7.1/classes/ActionCable/Channel/Base.html

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -82,7 +82,7 @@ <h2 id="class-ActionCable::Channel::Base-label-Action+processing">Action process
8282
end
8383
</code></pre>
8484

85-
<p>In this example, the subscribed and unsubscribed methods are not callable methods, as they were already declared in <a href="Base.html"><code>ActionCable::Channel::Base</code></a>, but <code>#appear</code> and <code>#away</code> are. <code>#generate_connection_token</code> is also not callable, since it’s a private method. You’ll see that appear accepts a data parameter, which it then uses as part of its model call. <code>#away</code> does not, since it’s simply a trigger action.</p>
85+
<p>In this example, the subscribed and unsubscribed methods are not callable methods, as they were already declared in <a href="Base.html"><code>ActionCable::Channel::Base</code></a>, but appear and away are. generate_connection_token is also not callable, since it’s a private method. You’ll see that appear accepts a data parameter, which it then uses as part of its model call. away does not, since it’s simply a trigger action.</p>
8686

8787
<p>Also note that in this example, <code>current_user</code> is available because it was marked as an identifying attribute on the connection. All such identifiers will automatically create a delegation method of the same name on the channel instance.</p>
8888

src/7.1/classes/ActionCable/Channel/ChannelStub.html

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -25,7 +25,7 @@ <h1>
2525

2626
<h1 id="module-ActionCable::Channel::ChannelStub-label-Action+Cable+Channel+Stub">Action Cable Channel Stub</h1>
2727

28-
<p>Stub <code>stream_from</code> to track streams for the channel. Add public aliases for <code>subscription_confirmation_sent?</code> and <code>subscription_rejected?</code>.</p>
28+
<p>Stub <a href="ChannelStub.html#method-i-stream_from"><code>stream_from</code></a> to track streams for the channel. Add public aliases for <code>subscription_confirmation_sent?</code> and <code>subscription_rejected?</code>.</p>
2929

3030
</div>
3131

src/7.1/classes/ActionCable/Channel/Naming/ClassMethods.html

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -66,7 +66,7 @@ <h3 id="method-i-channel_name">
6666

6767

6868
<div class="description">
69-
<p>Returns the name of the channel, underscored, without the <code>Channel</code> ending. If the channel is in a namespace, then the namespaces are represented by single colon separators in the channel name.</p>
69+
<p>Returns the name of the channel, underscored, without the <a href="../../Channel.html"><code>Channel</code></a> ending. If the channel is in a namespace, then the namespaces are represented by single colon separators in the channel name.</p>
7070

7171
<pre><code>ChatChannel.channel_name # =&gt; &#39;chat&#39;
7272
Chats::AppearancesChannel.channel_name # =&gt; &#39;chats:appearances&#39;

src/7.1/classes/ActionCable/Channel/TestCase.html

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -88,13 +88,13 @@ <h2 id="class-ActionCable::Channel::TestCase-label-Basic+example">Basic example<
8888
<h2 id="class-ActionCable::Channel::TestCase-label-Special+methods">Special methods</h2>
8989

9090
<p><a href="TestCase.html"><code>ActionCable::Channel::TestCase</code></a> will also automatically provide the following instance methods for use in the tests:</p>
91-
<dl class="rdoc-list note-list"><dt>connection
91+
<dl class="rdoc-list note-list"><dt>connection</dt>
9292
<dd>
9393
<p>An <a href="ConnectionStub.html"><code>ActionCable::Channel::ConnectionStub</code></a>, representing the current HTTP connection.</p>
94-
</dd><dt>subscription
94+
</dd><dt>subscription</dt>
9595
<dd>
9696
<p>An instance of the current channel, created when you call <code>subscribe</code>.</p>
97-
</dd><dt>transmissions
97+
</dd><dt>transmissions</dt>
9898
<dd>
9999
<p>A list of all messages that have been transmitted into the channel.</p>
100100
</dd></dl>

src/7.1/classes/ActionCable/RemoteConnections/RemoteConnection.html

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -31,7 +31,7 @@ <h1>
3131

3232
<h1 id="class-ActionCable::RemoteConnections::RemoteConnection-label-Action+Cable+Remote+Connection">Action Cable Remote Connection</h1>
3333

34-
<p>Represents a single remote connection found via <code>ActionCable.server.remote_connections.where(*)</code>. Exists solely for the purpose of calling <a href="RemoteConnection.html#method-i-disconnect"><code>disconnect</code></a> on that connection.</p>
34+
<p>Represents a single remote connection found via <a href="../../ActionCable.html#method-i-server"><code>ActionCable.server.remote_connections.where(*)</code></a>. Exists solely for the purpose of calling <a href="RemoteConnection.html#method-i-disconnect"><code>disconnect</code></a> on that connection.</p>
3535

3636
</div>
3737

src/7.1/classes/ActionCable/SubscriptionAdapter/Test.html

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -35,7 +35,7 @@ <h2 id="class-ActionCable::SubscriptionAdapter::Test-label-Test+adapter+for+Acti
3535

3636
<p>To use the test adapter set <code>adapter</code> value to <code>test</code> in your <code>config/cable.yml</code> file.</p>
3737

38-
<p>NOTE: <code>Test</code> adapter extends the <code>ActionCable::SubscriptionAdapter::Async</code> adapter, so it could be used in system tests too.</p>
38+
<p>NOTE: <a href="Test.html"><code>Test</code></a> adapter extends the <a href="Async.html"><code>ActionCable::SubscriptionAdapter::Async</code></a> adapter, so it could be used in system tests too.</p>
3939

4040
</div>
4141

src/7.1/classes/ActionController/API.html

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -35,7 +35,7 @@ <h1 id="class-ActionController::API-label-Action+Controller+API">Action Controll
3535

3636
<p>An <a href="API.html"><code>API</code></a> Controller is different from a normal controller in the sense that by default it doesn’t include a number of features that are usually required by browser access only: layouts and templates rendering, flash, assets, and so on. This makes the entire controller stack thinner, suitable for <a href="API.html"><code>API</code></a> applications. It doesn’t mean you won’t have such features if you need them: they’re all available for you to include in your application, they’re just not part of the default <a href="API.html"><code>API</code></a> controller stack.</p>
3737

38-
<p>Normally, <code>ApplicationController</code> is the only controller that inherits from <code>ActionController::API</code>. All other controllers in turn inherit from <code>ApplicationController</code>.</p>
38+
<p>Normally, <code>ApplicationController</code> is the only controller that inherits from <a href="API.html"><code>ActionController::API</code></a>. All other controllers in turn inherit from <code>ApplicationController</code>.</p>
3939

4040
<p>A sample controller could look like this:</p>
4141

@@ -71,7 +71,7 @@ <h2 id="class-ActionController::API-label-Redirects">Redirects</h2>
7171

7272
<h2 id="class-ActionController::API-label-Adding+New+Behavior">Adding New Behavior</h2>
7373

74-
<p>In some scenarios you may want to add back some functionality provided by <a href="Base.html"><code>ActionController::Base</code></a> that is not present by default in <code>ActionController::API</code>, for instance <code>MimeResponds</code>. This module gives you the <code>respond_to</code> method. Adding it is quite simple, you just need to include the module in a specific controller or in <code>ApplicationController</code> in case you want it available in your entire application:</p>
74+
<p>In some scenarios you may want to add back some functionality provided by <a href="Base.html"><code>ActionController::Base</code></a> that is not present by default in <a href="API.html"><code>ActionController::API</code></a>, for instance <a href="MimeResponds.html"><code>MimeResponds</code></a>. This module gives you the <code>respond_to</code> method. Adding it is quite simple, you just need to include the module in a specific controller or in <code>ApplicationController</code> in case you want it available in your entire application:</p>
7575

7676
<pre><code>class ApplicationController &lt; ActionController::API
7777
include ActionController::MimeResponds
@@ -89,7 +89,7 @@ <h2 id="class-ActionController::API-label-Adding+New+Behavior">Adding New Behavi
8989
end
9090
</code></pre>
9191

92-
<p>Make sure to check the modules included in <a href="Base.html"><code>ActionController::Base</code></a> if you want to use any other functionality that is not provided by <code>ActionController::API</code> out of the box.</p>
92+
<p>Make sure to check the modules included in <a href="Base.html"><code>ActionController::Base</code></a> if you want to use any other functionality that is not provided by <a href="API.html"><code>ActionController::API</code></a> out of the box.</p>
9393

9494
</div>
9595

0 commit comments

Comments
 (0)