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

Lines changed: 3 additions & 3 deletions
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

Lines changed: 1 addition & 1 deletion
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

Lines changed: 2 additions & 2 deletions
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

Lines changed: 1 addition & 1 deletion
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

Lines changed: 4 additions & 4 deletions
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

Lines changed: 2 additions & 2 deletions
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

Lines changed: 1 addition & 1 deletion
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

Lines changed: 2 additions & 2 deletions
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

Lines changed: 2 additions & 2 deletions
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

Lines changed: 1 addition & 1 deletion
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
#

0 commit comments

Comments
 (0)