Skip to content

Commit 07bee94

Browse files
Replace backticks with RDoc markup [ci-skip]
RDoc does not support backticks the way that Markdown does. Instead, inline code must be wrapped with `+` or `<tt>`.
1 parent 0d3effc commit 07bee94

File tree

15 files changed

+23
-23
lines changed

15 files changed

+23
-23
lines changed

actionpack/lib/action_controller/metal/redirecting.rb

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -74,7 +74,7 @@ class UnsafeRedirectError < StandardError; end
7474
#
7575
# Raises UnsafeRedirectError in the case of an unsafe redirect.
7676
#
77-
# To allow any external redirects pass `allow_other_host: true`, though using a user-provided param in that case is unsafe.
77+
# To allow any external redirects pass <tt>allow_other_host: true</tt>, though using a user-provided param in that case is unsafe.
7878
#
7979
# redirect_to "https://rubyonrails.org", allow_other_host: true
8080
#

actionpack/lib/action_controller/metal/strong_parameters.rb

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -236,7 +236,7 @@ class Parameters
236236
# By default, never raise an UnpermittedParameters exception if these
237237
# params are present. The default includes both 'controller' and 'action'
238238
# because they are added by Rails and should be of no concern. One way
239-
# to change these is to specify `always_permitted_parameters` in your
239+
# to change these is to specify +always_permitted_parameters+ in your
240240
# config. For instance:
241241
#
242242
# config.action_controller.always_permitted_parameters = %w( controller action format )

actionview/lib/action_view/helpers/form_options_helper.rb

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -598,7 +598,7 @@ def time_zone_options_for_select(selected = nil, priority_zones = nil, model = :
598598
#
599599
# Options:
600600
# * <tt>:index_as_value</tt> - Defaults to false, set to true to use the indexes from
601-
# `I18n.translate("date.day_names")` as the values. By default, Sunday is always 0.
601+
# <tt>I18n.translate("date.day_names")</tt> as the values. By default, Sunday is always 0.
602602
# * <tt>:day_format</tt> - The I18n key of the array to use for the weekday options.
603603
# Defaults to :day_names, set to :abbr_day_names for abbreviations.
604604
# * <tt>:beginning_of_week</tt> - Defaults to Date.beginning_of_week.

actionview/lib/action_view/helpers/tag_helper.rb

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -240,7 +240,7 @@ def method_missing(called, *args, **options, &block)
240240
# Transforms a Hash into HTML attributes, ready to be interpolated into
241241
# ERB. Includes or omits boolean attributes based on their truthiness.
242242
# Transforms keys nested within
243-
# <tt>aria:</tt> or <tt>data:</tt> objects into `aria-` and `data-`
243+
# <tt>aria:</tt> or <tt>data:</tt> objects into <tt>aria-</tt> and <tt>data-</tt>
244244
# prefixed attributes:
245245
#
246246
# <input <%= tag.attributes(type: :text, aria: { label: "Search" }) %>>

activerecord/lib/active_record/associations.rb

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -1416,8 +1416,8 @@ module ClassMethods
14161416
# [:disable_joins]
14171417
# Specifies whether joins should be skipped for an association. If set to true, two or more queries
14181418
# will be generated. Note that in some cases, if order or limit is applied, it will be done in-memory
1419-
# due to database limitations. This option is only applicable on `has_many :through` associations as
1420-
# `has_many` alone do not perform a join.
1419+
# due to database limitations. This option is only applicable on <tt>has_many :through</tt> associations as
1420+
# +has_many+ alone do not perform a join.
14211421
# [:source]
14221422
# Specifies the source association name used by #has_many <tt>:through</tt> queries.
14231423
# Only use it if the name cannot be inferred from the association.
@@ -1581,8 +1581,8 @@ def has_many(name, scope = nil, **options, &extension)
15811581
# [:disable_joins]
15821582
# Specifies whether joins should be skipped for an association. If set to true, two or more queries
15831583
# will be generated. Note that in some cases, if order or limit is applied, it will be done in-memory
1584-
# due to database limitations. This option is only applicable on `has_one :through` associations as
1585-
# `has_one` alone does not perform a join.
1584+
# due to database limitations. This option is only applicable on <tt>has_one :through</tt> associations as
1585+
# +has_one+ alone does not perform a join.
15861586
# [:source]
15871587
# Specifies the source association name used by #has_one <tt>:through</tt> queries.
15881588
# Only use it if the name cannot be inferred from the association.

activerecord/lib/active_record/connection_adapters/abstract_adapter.rb

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -241,13 +241,13 @@ def connection_class # :nodoc:
241241
end
242242

243243
# The role (e.g. +:writing+) for the current connection. In a
244-
# non-multi role application, `:writing` is returned.
244+
# non-multi role application, +:writing+ is returned.
245245
def role
246246
@pool.role
247247
end
248248

249249
# The shard (e.g. +:default+) for the current connection. In
250-
# a non-sharded application, `:default` is returned.
250+
# a non-sharded application, +:default+ is returned.
251251
def shard
252252
@pool.shard
253253
end

activerecord/lib/active_record/connection_adapters/postgresql_adapter.rb

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -104,7 +104,7 @@ def new_client(conn_params)
104104

105105
##
106106
# :singleton-method:
107-
# PostgreSQL supports multiple types for DateTimes. By default, if you use `datetime`
107+
# PostgreSQL supports multiple types for DateTimes. By default, if you use +datetime+
108108
# in migrations, Rails will translate this to a PostgreSQL "timestamp without time zone".
109109
# Change this in an initializer to use another NATIVE_DATABASE_TYPES. For example, to
110110
# store DateTimes as "timestamp with time zone":

activerecord/lib/active_record/core.rb

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -60,7 +60,7 @@ def self.configurations
6060
##
6161
# :singleton-method:
6262
# Force enumeration of all columns in SELECT statements.
63-
# e.g. `SELECT first_name, last_name FROM ...` instead of `SELECT * FROM ...`
63+
# e.g. <tt>SELECT first_name, last_name FROM ...</tt> instead of <tt>SELECT * FROM ...</tt>
6464
# This avoids +PreparedStatementCacheExpired+ errors when a column is added
6565
# to the database while the app is running.
6666
class_attribute :enumerate_columns_in_select_statements, instance_accessor: false, default: false

activerecord/lib/active_record/encryption/encryptable_record.rb

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -23,7 +23,7 @@ module EncryptableRecord
2323
# * <tt>:key</tt> - A password to derive the key from. It's a shorthand for a +:key_provider+ that
2424
# serves derivated keys. Both options can't be used at the same time.
2525
# * <tt>:key_provider</tt> - Set a +:key_provider+ to provide encryption and decryption keys. If not
26-
# provided, it will default to the key provider set with `config.key_provider`.
26+
# provided, it will default to the key provider set with +config.key_provider+.
2727
# * <tt>:deterministic</tt> - By default, encryption is not deterministic. It will use a random
2828
# initialization vector for each encryption operation. This means that encrypting the same content
2929
# with the same key twice will generate different ciphertexts. When set to +true+, it will generate the

activerecord/lib/active_record/encryption/envelope_encryption_key_provider.rb

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -10,7 +10,7 @@ module Encryption
1010
#
1111
# This provider can work with multiple master keys. It will use the last one for encrypting.
1212
#
13-
# When `config.store_key_references` is true, it will also store a reference to
13+
# When +config.store_key_references+ is true, it will also store a reference to
1414
# the specific master key that was used to encrypt the data-encryption key. When not set,
1515
# it will try all the configured master keys looking for the right one, in order to
1616
# return the right decryption key.

0 commit comments

Comments
 (0)