Skip to content

Commit

Permalink
🔗 Remove RDoc auto-link from Rails module everywhere
Browse files Browse the repository at this point in the history
  • Loading branch information
zzak committed Jun 23, 2023
1 parent 06da26a commit dd89f60
Show file tree
Hide file tree
Showing 95 changed files with 222 additions and 222 deletions.
6 changes: 3 additions & 3 deletions actioncable/README.md
Original file line number Diff line number Diff line change
@@ -1,8 +1,8 @@
# Action Cable – Integrated WebSockets for Rails
# Action Cable – Integrated WebSockets for \Rails

Action Cable seamlessly integrates WebSockets with the rest of your Rails application.
Action Cable seamlessly integrates WebSockets with the rest of your \Rails application.
It allows for real-time features to be written in Ruby in the same style
and form as the rest of your Rails application, while still being performant
and form as the rest of your \Rails application, while still being performant
and scalable. It's a full-stack offering that provides both a client-side
JavaScript framework and a server-side Ruby framework. You have access to your full
domain model written with Active Record or your ORM of choice.
Expand Down
2 changes: 1 addition & 1 deletion actioncable/lib/action_cable/server/configuration.rb
Original file line number Diff line number Diff line change
Expand Up @@ -5,7 +5,7 @@ module Server
# = Action Cable \Server \Configuration
#
# An instance of this configuration object is available via ActionCable.server.config, which allows you to tweak Action Cable configuration
# in a Rails config initializer.
# in a \Rails config initializer.
class Configuration
attr_accessor :logger, :log_tags
attr_accessor :connection_class, :worker_pool_size
Expand Down
4 changes: 2 additions & 2 deletions actioncable/lib/action_cable/subscription_adapter/test.rb
Original file line number Diff line number Diff line change
Expand Up @@ -5,11 +5,11 @@ module SubscriptionAdapter
# == \Test adapter for Action Cable
#
# The test adapter should be used only in testing. Along with
# ActionCable::TestHelper it makes a great tool to test your Rails application.
# ActionCable::TestHelper it makes a great tool to test your \Rails application.
#
# To use the test adapter set +adapter+ value to +test+ in your +config/cable.yml+ file.
#
# NOTE: Test adapter extends the +ActionCable::SubscriptionAdapter::Async+ adapter,
# NOTE: +Test+ adapter extends the +ActionCable::SubscriptionAdapter::Async+ adapter,
# so it could be used in system tests too.
class Test < Async
def broadcast(channel, payload)
Expand Down
2 changes: 1 addition & 1 deletion actionmailbox/README.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
# Action Mailbox

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.
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.

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.

Expand Down
8 changes: 4 additions & 4 deletions actionmailer/lib/action_mailer/base.rb
Original file line number Diff line number Diff line change
Expand Up @@ -267,7 +267,7 @@ module ActionMailer
# the delivery agents. Your class should make any needed modifications directly to the passed
# in +Mail::Message+ instance.
#
# = Default Hash
# = Default \Hash
#
# Action Mailer provides some intelligent defaults for your emails, these are usually specified in a
# default method inside the class definition:
Expand Down Expand Up @@ -316,7 +316,7 @@ module ActionMailer
#
# config.action_mailer.default_options = { from: "[email protected]" }
#
# = Callbacks
# = \Callbacks
#
# You can specify callbacks using <tt>before_action</tt> and <tt>after_action</tt> for configuring your messages,
# and using <tt>before_deliver</tt> and <tt>after_deliver</tt> for wrapping the delivery process.
Expand Down Expand Up @@ -783,7 +783,7 @@ def _raise_error
# the most used headers in an email message, these are:
#
# * +:subject+ - The subject of the message, if this is omitted, Action Mailer will
# ask the Rails I18n class for a translated +:subject+ in the scope of
# ask the \Rails I18n class for a translated +:subject+ in the scope of
# <tt>[mailer_scope, action_name]</tt> or if this is missing, will translate the
# humanized version of the +action_name+
# * +:to+ - Who the message is destined for, can be a string of addresses, or an array
Expand Down Expand Up @@ -929,7 +929,7 @@ def set_content_type(m, user_content_type, class_default) # :doc:
end
end

# Translates the +subject+ using Rails I18n class under <tt>[mailer_scope, action_name]</tt> scope.
# Translates the +subject+ using \Rails I18n class under <tt>[mailer_scope, action_name]</tt> scope.
# If it does not find a translation for the +subject+ under the specified scope it will default to a
# humanized version of the <tt>action_name</tt>.
# If the subject has interpolations, you can pass them through the +interpolations+ parameter.
Expand Down
4 changes: 2 additions & 2 deletions actionpack/README.rdoc
Original file line number Diff line number Diff line change
Expand Up @@ -16,11 +16,11 @@ It consists of several modules:
subclassed to implement filters and actions to handle requests. The result
of an action is typically content generated from views.

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

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

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -316,7 +316,7 @@ def secret_token(request)
# of this document.
#
# The nonce is opaque to the client. Composed of Time, and hash of Time with secret
# key from the Rails session secret generated upon creation of project. Ensures
# key from the \Rails session secret generated upon creation of project. Ensures
# the time cannot be modified by client.
def nonce(secret_key, time = Time.now)
t = time.to_i
Expand Down
4 changes: 2 additions & 2 deletions actionpack/lib/action_controller/metal/mime_responds.rb
Original file line number Diff line number Diff line change
Expand Up @@ -32,7 +32,7 @@ module MimeResponds
#
# What that says is, "if the client wants HTML or JS in response to this action, just respond as we
# would have before, but if the client wants XML, return them the list of people in XML format."
# (Rails determines the desired response format from the HTTP Accept header submitted by the client.)
# (\Rails determines the desired response format from the HTTP Accept header submitted by the client.)
#
# Supposing you have an action that adds a new person, optionally creating their company
# (by name) if it does not already exist, without web-services, it might look like this:
Expand Down Expand Up @@ -98,7 +98,7 @@ module MimeResponds
#
# Note that you can define your own XML parameter parser which would allow you to describe multiple entities
# in a single request (i.e., by wrapping them all in a single root node), but if you just go with the flow
# and accept Rails' defaults, life will be much easier.
# and accept \Rails' defaults, life will be much easier.
#
# If you need to use a MIME type which isn't supported by default, you can register your own handlers in
# +config/initializers/mime_types.rb+ as follows.
Expand Down
4 changes: 2 additions & 2 deletions actionpack/lib/action_controller/metal/redirecting.rb
Original file line number Diff line number Diff line change
Expand Up @@ -65,8 +65,8 @@ class UnsafeRedirectError < StandardError; end
#
# === Open Redirect protection
#
# By default, Rails protects against redirecting to external hosts for your app's safety, so called open redirects.
# 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>
# By default, \Rails protects against redirecting to external hosts for your app's safety, so called open redirects.
# 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>
#
# Here #redirect_to automatically validates the potentially-unsafe URL:
#
Expand Down
2 changes: 1 addition & 1 deletion actionpack/lib/action_controller/metal/renderers.rb
Original file line number Diff line number Diff line change
Expand Up @@ -58,7 +58,7 @@ module All
# disposition: "attachment; filename=#{filename}.csv"
# end
#
# Note that we used Mime[:csv] for the csv mime type as it comes with Rails.
# Note that we used Mime[:csv] for the csv mime type as it comes with \Rails.
# For a custom renderer, you'll need to register a mime type with
# <tt>Mime::Type.register</tt>.
#
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -39,7 +39,7 @@ class InvalidCrossOriginRequest < ActionControllerError # :nodoc:
# ActionController::InvalidAuthenticityToken error on unverified requests.
#
# APIs may want to disable this behavior since they are typically designed to be
# state-less: that is, the request API client handles the session instead of Rails.
# state-less: that is, the request API client handles the session instead of \Rails.
# One way to achieve this is to use the <tt>:null_session</tt> strategy instead,
# which allows unverified requests to be handled, but with an empty session:
#
Expand Down
6 changes: 3 additions & 3 deletions actionpack/lib/action_controller/test_case.rb
Original file line number Diff line number Diff line change
Expand Up @@ -239,10 +239,10 @@ def load!
#
# == Use integration style controller tests over functional style controller tests.
#
# Rails discourages the use of functional tests in favor of integration tests
# \Rails discourages the use of functional tests in favor of integration tests
# (use ActionDispatch::IntegrationTest).
#
# New Rails applications no longer generate functional style controller tests and they should
# New \Rails applications no longer generate functional style controller tests and they should
# only be used for backward compatibility. Integration style controller tests perform actual
# requests, whereas functional style controller tests merely simulate a request. Besides,
# integration tests are as fast as functional tests and provide lot of helpers such as +as+,
Expand Down Expand Up @@ -477,7 +477,7 @@ def head(action, **args)
#
# It's not recommended to make more than one request in the same test. Instance
# variables that are set in one request will not persist to the next request,
# but it's not guaranteed that all Rails internal state will be reset. Prefer
# but it's not guaranteed that all \Rails internal state will be reset. Prefer
# ActionDispatch::IntegrationTest for making multiple requests in the same test.
#
# Note that the request method is not verified.
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -8,7 +8,7 @@ module ActionDispatch
module Session
# = Action Dispatch Session \CookieStore
#
# This cookie-based session store is the Rails default. It is
# This cookie-based session store is the \Rails default. It is
# dramatically faster than the alternatives.
#
# Sessions typically contain at most a user ID and flash message; both fit
Expand All @@ -20,18 +20,18 @@ module Session
#
# Your cookies will be encrypted using your application's +secret_key_base+. This
# goes a step further than signed cookies in that encrypted cookies cannot
# be altered or read by users. This is the default starting in Rails 4.
# be altered or read by users. This is the default starting in \Rails 4.
#
# Configure your session store in an initializer:
#
# Rails.application.config.session_store :cookie_store, key: '_your_app_session'
#
# In the development and test environments your application's +secret_key_base+ is
# generated by Rails and stored in a temporary file in <tt>tmp/local_secret.txt</tt>.
# generated by \Rails and stored in a temporary file in <tt>tmp/local_secret.txt</tt>.
# In all other environments, it is stored encrypted in the
# <tt>config/credentials.yml.enc</tt> file.
#
# If your application was not updated to Rails 5.2 defaults, the +secret_key_base+
# If your application was not updated to \Rails 5.2 defaults, the +secret_key_base+
# will be found in the old <tt>config/secrets.yml</tt> file.
#
# Note that changing your +secret_key_base+ will invalidate all existing session.
Expand Down
2 changes: 1 addition & 1 deletion actionpack/lib/action_dispatch/middleware/static.rb
Original file line number Diff line number Diff line change
Expand Up @@ -8,7 +8,7 @@ module ActionDispatch
# This middleware serves static files from disk, if available.
# If no file is found, it hands off to the main app.
#
# In Rails apps, this middleware is configured to serve assets from
# In \Rails apps, this middleware is configured to serve assets from
# the +public/+ directory.
#
# Only GET and HEAD requests are served. POST and other HTTP methods
Expand Down
10 changes: 5 additions & 5 deletions actionpack/lib/action_dispatch/routing/mapper.rb
Original file line number Diff line number Diff line change
Expand Up @@ -760,7 +760,7 @@ def map_method(method, args, &block)
# end
#
# This will create a number of routes for each of the posts and comments
# controller. For +Admin::PostsController+, Rails will create:
# controller. For +Admin::PostsController+, \Rails will create:
#
# GET /admin/posts
# GET /admin/posts/new
Expand Down Expand Up @@ -1330,7 +1330,7 @@ def resource(*resources, &block)
self
end

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

# You can specify what Rails should route "/" to with the root method:
# You can specify what \Rails should route "/" to with the root method:
#
# root to: 'pages#main'
#
Expand All @@ -1687,7 +1687,7 @@ def match(path, *rest, &block)
#
# You should put the root route at the top of <tt>config/routes.rb</tt>,
# because this means it will be matched first. As this is the most popular route
# of most Rails applications, this is beneficial.
# of most \Rails applications, this is beneficial.
def root(path, options = {})
if path.is_a?(String)
options[:to] = path
Expand Down
2 changes: 1 addition & 1 deletion actionpack/lib/action_dispatch/routing/url_for.rb
Original file line number Diff line number Diff line change
Expand Up @@ -39,7 +39,7 @@ module Routing
# # => "/users/new?message=Welcome%21"
#
# Notice the <tt>only_path: true</tt> part. This is because UrlFor has no
# information about the website hostname that your Rails app is serving. So if you
# information about the website hostname that your \Rails app is serving. So if you
# want to include the hostname as well, then you must also pass the <tt>:host</tt>
# argument:
#
Expand Down
2 changes: 1 addition & 1 deletion actionpack/lib/action_dispatch/system_test_case.rb
Original file line number Diff line number Diff line change
Expand Up @@ -107,7 +107,7 @@ module ActionDispatch
# end
#
# Because +ActionDispatch::SystemTestCase+ is a shim between Capybara
# and Rails, any driver that is supported by Capybara is supported by system
# and \Rails, any driver that is supported by Capybara is supported by system
# tests as long as you include the required gems and files.
class SystemTestCase < ActiveSupport::TestCase
include Capybara::DSL
Expand Down
2 changes: 1 addition & 1 deletion actionpack/lib/action_dispatch/testing/integration.rb
Original file line number Diff line number Diff line change
Expand Up @@ -635,7 +635,7 @@ def method_missing(method, *args, &block)
# +response_parser+ defines how the response body should be parsed through
# +parsed_body+.
#
# Consult the Rails Testing Guide for more.
# Consult the {Rails Testing Guide}[https://guides.rubyonrails.org/testing.html] for more.

class IntegrationTest < ActiveSupport::TestCase
include TestProcess::FixtureFile
Expand Down
2 changes: 1 addition & 1 deletion actiontext/README.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
# Action Text

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.
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.

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

Expand Down
4 changes: 2 additions & 2 deletions actionview/lib/action_view/base.rb
Original file line number Diff line number Diff line change
Expand Up @@ -82,8 +82,8 @@ module ActionView # :nodoc:
#
# === Template caching
#
# By default, Rails will compile each template to a method in order to render it. When you alter a template,
# Rails will check the file's modification time and recompile it in development mode.
# By default, \Rails will compile each template to a method in order to render it. When you alter a template,
# \Rails will check the file's modification time and recompile it in development mode.
#
# == Builder
#
Expand Down
4 changes: 2 additions & 2 deletions actionview/lib/action_view/helpers/asset_tag_helper.rb
Original file line number Diff line number Diff line change
Expand Up @@ -43,7 +43,7 @@ module AssetTagHelper
# source, and include other JavaScript or CoffeeScript files inside the manifest.
#
# If the server supports HTTP Early Hints, and the +defer+ option is not
# enabled, Rails will push a <tt>103 Early Hints</tt> response that links
# enabled, \Rails will push a <tt>103 Early Hints</tt> response that links
# to the assets.
#
# ==== Options
Expand Down Expand Up @@ -152,7 +152,7 @@ def javascript_include_tag(*sources)
# set <tt>extname: false</tt> in the options.
# You can modify the link attributes by passing a hash as the last argument.
#
# If the server supports HTTP Early Hints, Rails will push a <tt>103 Early
# If the server supports HTTP Early Hints, \Rails will push a <tt>103 Early
# Hints</tt> response that links to the assets.
#
# ==== Options
Expand Down
6 changes: 3 additions & 3 deletions actionview/lib/action_view/helpers/asset_url_helper.rb
Original file line number Diff line number Diff line change
Expand Up @@ -17,8 +17,8 @@ module Helpers # :nodoc:
#
# === Using asset hosts
#
# By default, Rails links to these assets on the current host in the public
# folder, but you can direct Rails to link to assets from a dedicated asset
# By default, \Rails links to these assets on the current host in the public
# folder, but you can direct \Rails to link to assets from a dedicated asset
# server by setting <tt>ActionController::Base.asset_host</tt> in the application
# configuration, typically in <tt>config/environments/production.rb</tt>.
# For example, you'd define <tt>assets.example.com</tt> to be your asset
Expand Down Expand Up @@ -373,7 +373,7 @@ def stylesheet_url(source, options = {})
# image_path("http://www.example.com/img/edit.png") # => "http://www.example.com/img/edit.png"
#
# If you have images as application resources this method may conflict with their named routes.
# The alias +path_to_image+ is provided to avoid that. Rails uses the alias internally, and
# The alias +path_to_image+ is provided to avoid that. \Rails uses the alias internally, and
# plugin authors are encouraged to do so.
def image_path(source, options = {})
path_to_asset(source, { type: :image }.merge!(options))
Expand Down
2 changes: 1 addition & 1 deletion actionview/lib/action_view/helpers/csp_helper.rb
Original file line number Diff line number Diff line change
Expand Up @@ -11,7 +11,7 @@ module CspHelper
# <%= csp_meta_tag %>
# </head>
#
# This is used by the Rails UJS helper to create dynamically
# This is used by the \Rails UJS helper to create dynamically
# loaded inline <script> elements.
#
def csp_meta_tag(**options)
Expand Down
Loading

0 comments on commit dd89f60

Please sign in to comment.