Skip to content

Commit dd89f60

Browse files
committed
🔗 Remove RDoc auto-link from Rails module everywhere
1 parent 06da26a commit dd89f60

File tree

95 files changed

+222
-222
lines changed

Some content is hidden

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

95 files changed

+222
-222
lines changed

actioncable/README.md

+3-3
Original file line numberDiff line numberDiff line change
@@ -1,8 +1,8 @@
1-
# Action Cable – Integrated WebSockets for Rails
1+
# Action Cable – Integrated WebSockets for \Rails
22

3-
Action Cable seamlessly integrates WebSockets with the rest of your Rails application.
3+
Action Cable seamlessly integrates WebSockets with the rest of your \Rails application.
44
It allows for real-time features to be written in Ruby in the same style
5-
and form as the rest of your Rails application, while still being performant
5+
and form as the rest of your \Rails application, while still being performant
66
and scalable. It's a full-stack offering that provides both a client-side
77
JavaScript framework and a server-side Ruby framework. You have access to your full
88
domain model written with Active Record or your ORM of choice.

actioncable/lib/action_cable/server/configuration.rb

+1-1
Original file line numberDiff line numberDiff line change
@@ -5,7 +5,7 @@ module Server
55
# = Action Cable \Server \Configuration
66
#
77
# An instance of this configuration object is available via ActionCable.server.config, which allows you to tweak Action Cable configuration
8-
# in a Rails config initializer.
8+
# in a \Rails config initializer.
99
class Configuration
1010
attr_accessor :logger, :log_tags
1111
attr_accessor :connection_class, :worker_pool_size

actioncable/lib/action_cable/subscription_adapter/test.rb

+2-2
Original file line numberDiff line numberDiff line change
@@ -5,11 +5,11 @@ module SubscriptionAdapter
55
# == \Test adapter for Action Cable
66
#
77
# The test adapter should be used only in testing. Along with
8-
# ActionCable::TestHelper it makes a great tool to test your Rails application.
8+
# ActionCable::TestHelper it makes a great tool to test your \Rails application.
99
#
1010
# To use the test adapter set +adapter+ value to +test+ in your +config/cable.yml+ file.
1111
#
12-
# NOTE: Test adapter extends the +ActionCable::SubscriptionAdapter::Async+ adapter,
12+
# NOTE: +Test+ adapter extends the +ActionCable::SubscriptionAdapter::Async+ adapter,
1313
# so it could be used in system tests too.
1414
class Test < Async
1515
def broadcast(channel, payload)

actionmailbox/README.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
# Action Mailbox
22

3-
Action Mailbox routes incoming emails to controller-like mailboxes for processing in Rails. It ships with ingresses for Mailgun, Mandrill, Postmark, and SendGrid. You can also handle inbound mails directly via the built-in Exim, Postfix, and Qmail ingresses.
3+
Action Mailbox routes incoming emails to controller-like mailboxes for processing in \Rails. It ships with ingresses for Mailgun, Mandrill, Postmark, and SendGrid. You can also handle inbound mails directly via the built-in Exim, Postfix, and Qmail ingresses.
44

55
The inbound emails are turned into `InboundEmail` records using Active Record and feature lifecycle tracking, storage of the original email on cloud storage via Active Storage, and responsible data handling with on-by-default incineration.
66

actionmailer/lib/action_mailer/base.rb

+4-4
Original file line numberDiff line numberDiff line change
@@ -267,7 +267,7 @@ module ActionMailer
267267
# the delivery agents. Your class should make any needed modifications directly to the passed
268268
# in +Mail::Message+ instance.
269269
#
270-
# = Default Hash
270+
# = Default \Hash
271271
#
272272
# Action Mailer provides some intelligent defaults for your emails, these are usually specified in a
273273
# default method inside the class definition:
@@ -316,7 +316,7 @@ module ActionMailer
316316
#
317317
# config.action_mailer.default_options = { from: "[email protected]" }
318318
#
319-
# = Callbacks
319+
# = \Callbacks
320320
#
321321
# You can specify callbacks using <tt>before_action</tt> and <tt>after_action</tt> for configuring your messages,
322322
# and using <tt>before_deliver</tt> and <tt>after_deliver</tt> for wrapping the delivery process.
@@ -783,7 +783,7 @@ def _raise_error
783783
# the most used headers in an email message, these are:
784784
#
785785
# * +:subject+ - The subject of the message, if this is omitted, Action Mailer will
786-
# ask the Rails I18n class for a translated +:subject+ in the scope of
786+
# ask the \Rails I18n class for a translated +:subject+ in the scope of
787787
# <tt>[mailer_scope, action_name]</tt> or if this is missing, will translate the
788788
# humanized version of the +action_name+
789789
# * +:to+ - Who the message is destined for, can be a string of addresses, or an array
@@ -929,7 +929,7 @@ def set_content_type(m, user_content_type, class_default) # :doc:
929929
end
930930
end
931931

932-
# Translates the +subject+ using Rails I18n class under <tt>[mailer_scope, action_name]</tt> scope.
932+
# Translates the +subject+ using \Rails I18n class under <tt>[mailer_scope, action_name]</tt> scope.
933933
# If it does not find a translation for the +subject+ under the specified scope it will default to a
934934
# humanized version of the <tt>action_name</tt>.
935935
# If the subject has interpolations, you can pass them through the +interpolations+ parameter.

actionpack/README.rdoc

+2-2
Original file line numberDiff line numberDiff line change
@@ -16,11 +16,11 @@ It consists of several modules:
1616
subclassed to implement filters and actions to handle requests. The result
1717
of an action is typically content generated from views.
1818

19-
With the Ruby on Rails framework, users only directly interface with the
19+
With the Ruby on \Rails framework, users only directly interface with the
2020
Action Controller module. Necessary Action Dispatch functionality is activated
2121
by default and Action View rendering is implicitly triggered by Action
2222
Controller. However, these modules are designed to function on their own and
23-
can be used outside of Rails.
23+
can be used outside of \Rails.
2424

2525
You can read more about Action Pack in the {Action Controller Overview}[https://guides.rubyonrails.org/action_controller_overview.html] guide.
2626

actionpack/lib/action_controller/metal/http_authentication.rb

+1-1
Original file line numberDiff line numberDiff line change
@@ -316,7 +316,7 @@ def secret_token(request)
316316
# of this document.
317317
#
318318
# The nonce is opaque to the client. Composed of Time, and hash of Time with secret
319-
# key from the Rails session secret generated upon creation of project. Ensures
319+
# key from the \Rails session secret generated upon creation of project. Ensures
320320
# the time cannot be modified by client.
321321
def nonce(secret_key, time = Time.now)
322322
t = time.to_i

actionpack/lib/action_controller/metal/mime_responds.rb

+2-2
Original file line numberDiff line numberDiff line change
@@ -32,7 +32,7 @@ module MimeResponds
3232
#
3333
# What that says is, "if the client wants HTML or JS in response to this action, just respond as we
3434
# would have before, but if the client wants XML, return them the list of people in XML format."
35-
# (Rails determines the desired response format from the HTTP Accept header submitted by the client.)
35+
# (\Rails determines the desired response format from the HTTP Accept header submitted by the client.)
3636
#
3737
# Supposing you have an action that adds a new person, optionally creating their company
3838
# (by name) if it does not already exist, without web-services, it might look like this:
@@ -98,7 +98,7 @@ module MimeResponds
9898
#
9999
# Note that you can define your own XML parameter parser which would allow you to describe multiple entities
100100
# in a single request (i.e., by wrapping them all in a single root node), but if you just go with the flow
101-
# and accept Rails' defaults, life will be much easier.
101+
# and accept \Rails' defaults, life will be much easier.
102102
#
103103
# If you need to use a MIME type which isn't supported by default, you can register your own handlers in
104104
# +config/initializers/mime_types.rb+ as follows.

actionpack/lib/action_controller/metal/redirecting.rb

+2-2
Original file line numberDiff line numberDiff line change
@@ -65,8 +65,8 @@ class UnsafeRedirectError < StandardError; end
6565
#
6666
# === Open Redirect protection
6767
#
68-
# By default, Rails protects against redirecting to external hosts for your app's safety, so called open redirects.
69-
# Note: this was a new default in Rails 7.0, after upgrading opt-in by uncommenting the line with +raise_on_open_redirects+ in <tt>config/initializers/new_framework_defaults_7_0.rb</tt>
68+
# By default, \Rails protects against redirecting to external hosts for your app's safety, so called open redirects.
69+
# Note: this was a new default in \Rails 7.0, after upgrading opt-in by uncommenting the line with +raise_on_open_redirects+ in <tt>config/initializers/new_framework_defaults_7_0.rb</tt>
7070
#
7171
# Here #redirect_to automatically validates the potentially-unsafe URL:
7272
#

actionpack/lib/action_controller/metal/renderers.rb

+1-1
Original file line numberDiff line numberDiff line change
@@ -58,7 +58,7 @@ module All
5858
# disposition: "attachment; filename=#{filename}.csv"
5959
# end
6060
#
61-
# Note that we used Mime[:csv] for the csv mime type as it comes with Rails.
61+
# Note that we used Mime[:csv] for the csv mime type as it comes with \Rails.
6262
# For a custom renderer, you'll need to register a mime type with
6363
# <tt>Mime::Type.register</tt>.
6464
#

actionpack/lib/action_controller/metal/request_forgery_protection.rb

+1-1
Original file line numberDiff line numberDiff line change
@@ -39,7 +39,7 @@ class InvalidCrossOriginRequest < ActionControllerError # :nodoc:
3939
# ActionController::InvalidAuthenticityToken error on unverified requests.
4040
#
4141
# APIs may want to disable this behavior since they are typically designed to be
42-
# state-less: that is, the request API client handles the session instead of Rails.
42+
# state-less: that is, the request API client handles the session instead of \Rails.
4343
# One way to achieve this is to use the <tt>:null_session</tt> strategy instead,
4444
# which allows unverified requests to be handled, but with an empty session:
4545
#

actionpack/lib/action_controller/test_case.rb

+3-3
Original file line numberDiff line numberDiff line change
@@ -239,10 +239,10 @@ def load!
239239
#
240240
# == Use integration style controller tests over functional style controller tests.
241241
#
242-
# Rails discourages the use of functional tests in favor of integration tests
242+
# \Rails discourages the use of functional tests in favor of integration tests
243243
# (use ActionDispatch::IntegrationTest).
244244
#
245-
# New Rails applications no longer generate functional style controller tests and they should
245+
# New \Rails applications no longer generate functional style controller tests and they should
246246
# only be used for backward compatibility. Integration style controller tests perform actual
247247
# requests, whereas functional style controller tests merely simulate a request. Besides,
248248
# integration tests are as fast as functional tests and provide lot of helpers such as +as+,
@@ -477,7 +477,7 @@ def head(action, **args)
477477
#
478478
# It's not recommended to make more than one request in the same test. Instance
479479
# variables that are set in one request will not persist to the next request,
480-
# but it's not guaranteed that all Rails internal state will be reset. Prefer
480+
# but it's not guaranteed that all \Rails internal state will be reset. Prefer
481481
# ActionDispatch::IntegrationTest for making multiple requests in the same test.
482482
#
483483
# Note that the request method is not verified.

actionpack/lib/action_dispatch/middleware/session/cookie_store.rb

+4-4
Original file line numberDiff line numberDiff line change
@@ -8,7 +8,7 @@ module ActionDispatch
88
module Session
99
# = Action Dispatch Session \CookieStore
1010
#
11-
# This cookie-based session store is the Rails default. It is
11+
# This cookie-based session store is the \Rails default. It is
1212
# dramatically faster than the alternatives.
1313
#
1414
# Sessions typically contain at most a user ID and flash message; both fit
@@ -20,18 +20,18 @@ module Session
2020
#
2121
# Your cookies will be encrypted using your application's +secret_key_base+. This
2222
# goes a step further than signed cookies in that encrypted cookies cannot
23-
# be altered or read by users. This is the default starting in Rails 4.
23+
# be altered or read by users. This is the default starting in \Rails 4.
2424
#
2525
# Configure your session store in an initializer:
2626
#
2727
# Rails.application.config.session_store :cookie_store, key: '_your_app_session'
2828
#
2929
# In the development and test environments your application's +secret_key_base+ is
30-
# generated by Rails and stored in a temporary file in <tt>tmp/local_secret.txt</tt>.
30+
# generated by \Rails and stored in a temporary file in <tt>tmp/local_secret.txt</tt>.
3131
# In all other environments, it is stored encrypted in the
3232
# <tt>config/credentials.yml.enc</tt> file.
3333
#
34-
# If your application was not updated to Rails 5.2 defaults, the +secret_key_base+
34+
# If your application was not updated to \Rails 5.2 defaults, the +secret_key_base+
3535
# will be found in the old <tt>config/secrets.yml</tt> file.
3636
#
3737
# Note that changing your +secret_key_base+ will invalidate all existing session.

actionpack/lib/action_dispatch/middleware/static.rb

+1-1
Original file line numberDiff line numberDiff line change
@@ -8,7 +8,7 @@ module ActionDispatch
88
# This middleware serves static files from disk, if available.
99
# If no file is found, it hands off to the main app.
1010
#
11-
# In Rails apps, this middleware is configured to serve assets from
11+
# In \Rails apps, this middleware is configured to serve assets from
1212
# the +public/+ directory.
1313
#
1414
# Only GET and HEAD requests are served. POST and other HTTP methods

actionpack/lib/action_dispatch/routing/mapper.rb

+5-5
Original file line numberDiff line numberDiff line change
@@ -760,7 +760,7 @@ def map_method(method, args, &block)
760760
# end
761761
#
762762
# This will create a number of routes for each of the posts and comments
763-
# controller. For +Admin::PostsController+, Rails will create:
763+
# controller. For +Admin::PostsController+, \Rails will create:
764764
#
765765
# GET /admin/posts
766766
# GET /admin/posts/new
@@ -1330,7 +1330,7 @@ def resource(*resources, &block)
13301330
self
13311331
end
13321332

1333-
# In Rails, a resourceful route provides a mapping between HTTP verbs
1333+
# In \Rails, a resourceful route provides a mapping between HTTP verbs
13341334
# and URLs and controller actions. By convention, each action also maps
13351335
# to particular CRUD operations in a database. A single entry in the
13361336
# routing file, such as
@@ -1505,7 +1505,7 @@ def resources(*resources, &block)
15051505
# end
15061506
# end
15071507
#
1508-
# This will enable Rails to recognize paths such as <tt>/photos/search</tt>
1508+
# This will enable \Rails to recognize paths such as <tt>/photos/search</tt>
15091509
# with GET, and route to the search action of +PhotosController+. It will also
15101510
# create the <tt>search_photos_url</tt> and <tt>search_photos_path</tt>
15111511
# route helpers.
@@ -1675,7 +1675,7 @@ def match(path, *rest, &block)
16751675
end
16761676
end
16771677

1678-
# You can specify what Rails should route "/" to with the root method:
1678+
# You can specify what \Rails should route "/" to with the root method:
16791679
#
16801680
# root to: 'pages#main'
16811681
#
@@ -1687,7 +1687,7 @@ def match(path, *rest, &block)
16871687
#
16881688
# You should put the root route at the top of <tt>config/routes.rb</tt>,
16891689
# because this means it will be matched first. As this is the most popular route
1690-
# of most Rails applications, this is beneficial.
1690+
# of most \Rails applications, this is beneficial.
16911691
def root(path, options = {})
16921692
if path.is_a?(String)
16931693
options[:to] = path

actionpack/lib/action_dispatch/routing/url_for.rb

+1-1
Original file line numberDiff line numberDiff line change
@@ -39,7 +39,7 @@ module Routing
3939
# # => "/users/new?message=Welcome%21"
4040
#
4141
# Notice the <tt>only_path: true</tt> part. This is because UrlFor has no
42-
# information about the website hostname that your Rails app is serving. So if you
42+
# information about the website hostname that your \Rails app is serving. So if you
4343
# want to include the hostname as well, then you must also pass the <tt>:host</tt>
4444
# argument:
4545
#

actionpack/lib/action_dispatch/system_test_case.rb

+1-1
Original file line numberDiff line numberDiff line change
@@ -107,7 +107,7 @@ module ActionDispatch
107107
# end
108108
#
109109
# Because +ActionDispatch::SystemTestCase+ is a shim between Capybara
110-
# and Rails, any driver that is supported by Capybara is supported by system
110+
# and \Rails, any driver that is supported by Capybara is supported by system
111111
# tests as long as you include the required gems and files.
112112
class SystemTestCase < ActiveSupport::TestCase
113113
include Capybara::DSL

actionpack/lib/action_dispatch/testing/integration.rb

+1-1
Original file line numberDiff line numberDiff line change
@@ -635,7 +635,7 @@ def method_missing(method, *args, &block)
635635
# +response_parser+ defines how the response body should be parsed through
636636
# +parsed_body+.
637637
#
638-
# Consult the Rails Testing Guide for more.
638+
# Consult the {Rails Testing Guide}[https://guides.rubyonrails.org/testing.html] for more.
639639

640640
class IntegrationTest < ActiveSupport::TestCase
641641
include TestProcess::FixtureFile

actiontext/README.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
# Action Text
22

3-
Action Text brings rich text content and editing to Rails. It includes the [Trix editor](https://trix-editor.org) that handles everything from formatting to links to quotes to lists to embedded images and galleries. The rich text content generated by the Trix editor is saved in its own RichText model that's associated with any existing Active Record model in the application. Any embedded images (or other attachments) are automatically stored using Active Storage and associated with the included RichText model.
3+
Action Text brings rich text content and editing to \Rails. It includes the [Trix editor](https://trix-editor.org) that handles everything from formatting to links to quotes to lists to embedded images and galleries. The rich text content generated by the Trix editor is saved in its own RichText model that's associated with any existing Active Record model in the application. Any embedded images (or other attachments) are automatically stored using Active Storage and associated with the included RichText model.
44

55
You can read more about Action Text in the [Action Text Overview](https://guides.rubyonrails.org/action_text_overview.html) guide.
66

actionview/lib/action_view/base.rb

+2-2
Original file line numberDiff line numberDiff line change
@@ -82,8 +82,8 @@ module ActionView # :nodoc:
8282
#
8383
# === Template caching
8484
#
85-
# By default, Rails will compile each template to a method in order to render it. When you alter a template,
86-
# Rails will check the file's modification time and recompile it in development mode.
85+
# By default, \Rails will compile each template to a method in order to render it. When you alter a template,
86+
# \Rails will check the file's modification time and recompile it in development mode.
8787
#
8888
# == Builder
8989
#

actionview/lib/action_view/helpers/asset_tag_helper.rb

+2-2
Original file line numberDiff line numberDiff line change
@@ -43,7 +43,7 @@ module AssetTagHelper
4343
# source, and include other JavaScript or CoffeeScript files inside the manifest.
4444
#
4545
# If the server supports HTTP Early Hints, and the +defer+ option is not
46-
# enabled, Rails will push a <tt>103 Early Hints</tt> response that links
46+
# enabled, \Rails will push a <tt>103 Early Hints</tt> response that links
4747
# to the assets.
4848
#
4949
# ==== Options
@@ -152,7 +152,7 @@ def javascript_include_tag(*sources)
152152
# set <tt>extname: false</tt> in the options.
153153
# You can modify the link attributes by passing a hash as the last argument.
154154
#
155-
# If the server supports HTTP Early Hints, Rails will push a <tt>103 Early
155+
# If the server supports HTTP Early Hints, \Rails will push a <tt>103 Early
156156
# Hints</tt> response that links to the assets.
157157
#
158158
# ==== Options

actionview/lib/action_view/helpers/asset_url_helper.rb

+3-3
Original file line numberDiff line numberDiff line change
@@ -17,8 +17,8 @@ module Helpers # :nodoc:
1717
#
1818
# === Using asset hosts
1919
#
20-
# By default, Rails links to these assets on the current host in the public
21-
# folder, but you can direct Rails to link to assets from a dedicated asset
20+
# By default, \Rails links to these assets on the current host in the public
21+
# folder, but you can direct \Rails to link to assets from a dedicated asset
2222
# server by setting <tt>ActionController::Base.asset_host</tt> in the application
2323
# configuration, typically in <tt>config/environments/production.rb</tt>.
2424
# For example, you'd define <tt>assets.example.com</tt> to be your asset
@@ -373,7 +373,7 @@ def stylesheet_url(source, options = {})
373373
# image_path("http://www.example.com/img/edit.png") # => "http://www.example.com/img/edit.png"
374374
#
375375
# If you have images as application resources this method may conflict with their named routes.
376-
# The alias +path_to_image+ is provided to avoid that. Rails uses the alias internally, and
376+
# The alias +path_to_image+ is provided to avoid that. \Rails uses the alias internally, and
377377
# plugin authors are encouraged to do so.
378378
def image_path(source, options = {})
379379
path_to_asset(source, { type: :image }.merge!(options))

actionview/lib/action_view/helpers/csp_helper.rb

+1-1
Original file line numberDiff line numberDiff line change
@@ -11,7 +11,7 @@ module CspHelper
1111
# <%= csp_meta_tag %>
1212
# </head>
1313
#
14-
# This is used by the Rails UJS helper to create dynamically
14+
# This is used by the \Rails UJS helper to create dynamically
1515
# loaded inline <script> elements.
1616
#
1717
def csp_meta_tag(**options)

0 commit comments

Comments
 (0)