Skip to content

Commit b8b052e

Browse files
authored
Merge pull request rails#48023 from p8/docs/headers-active-record
Add more missing headers to Active Record docs [ci-skip]
2 parents b72b7c3 + 2d1ec4b commit b8b052e

22 files changed

+36
-6
lines changed

activerecord/lib/active_record/aggregations.rb

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -23,6 +23,8 @@ def init_internals
2323
@aggregation_cache = {}
2424
end
2525

26+
# = Active Record \Aggregations
27+
#
2628
# Active Record implements aggregation through a macro-like class method called #composed_of
2729
# for representing attributes as value objects. It expresses relationships like "Account [is]
2830
# composed of Money [among other things]" or "Person [is] composed of [an] address". Each call

activerecord/lib/active_record/associations.rb

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -333,6 +333,8 @@ def association_instance_set(name, association)
333333
@association_cache[name] = association
334334
end
335335

336+
# = Active Record \Associations
337+
#
336338
# \Associations are a set of macro-like class methods for tying objects together through
337339
# foreign keys. They express relationships like "Project has one Project Manager"
338340
# or "Project belongs to a Portfolio". Each macro adds a number of methods to the

activerecord/lib/active_record/attributes.rb

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -10,7 +10,7 @@ module Attributes
1010
included do
1111
class_attribute :attributes_to_define_after_schema_loads, instance_accessor: false, default: {} # :internal:
1212
end
13-
13+
# = Active Record \Attributes
1414
module ClassMethods
1515
# Defines an attribute with a type on this model. It will override the
1616
# type of existing attributes if needed. This allows control over how

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

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -5,7 +5,7 @@
55

66
module ActiveRecord
77
module ConnectionAdapters
8-
# = Active Record Connection Adapters Connection Handler
8+
# = Active Record Connection Handler
99
#
1010
# ConnectionHandler is a collection of ConnectionPool objects. It is used
1111
# for keeping separate connection pools that connect to different databases.

activerecord/lib/active_record/connection_adapters/abstract_adapter.rb

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -13,6 +13,8 @@
1313

1414
module ActiveRecord
1515
module ConnectionAdapters # :nodoc:
16+
# = Active Record Abstract Adapter
17+
#
1618
# Active Record supports multiple database systems. AbstractAdapter and
1719
# related classes form the abstraction layer which makes this possible.
1820
# An AbstractAdapter represents a connection to a database, and provides an

activerecord/lib/active_record/fixtures.rb

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -15,6 +15,8 @@ module ActiveRecord
1515
class FixtureClassNotFound < ActiveRecord::ActiveRecordError # :nodoc:
1616
end
1717

18+
# = Active Record \Fixtures
19+
#
1820
# \Fixtures are a way of organizing data that you want to test against; in short, sample data.
1921
#
2022
# They are stored in YAML files, one file per model, which are placed in the directories

activerecord/lib/active_record/inheritance.rb

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -4,7 +4,7 @@
44
require "active_support/core_ext/hash/indifferent_access"
55

66
module ActiveRecord
7-
# == Single table inheritance
7+
# = Single table inheritance
88
#
99
# Active Record allows inheritance by storing the name of the class in a column that by
1010
# default is named "type" (can be changed by overwriting <tt>Base.inheritance_column</tt>).

activerecord/lib/active_record/locking/optimistic.rb

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -2,7 +2,7 @@
22

33
module ActiveRecord
44
module Locking
5-
# == What is Optimistic Locking
5+
# == What is \Optimistic \Locking
66
#
77
# Optimistic locking allows multiple users to access the same record for edits, and assumes a minimum of
88
# conflicts with the data. It does this by checking whether another process has made changes to a record since

activerecord/lib/active_record/locking/pessimistic.rb

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -2,6 +2,8 @@
22

33
module ActiveRecord
44
module Locking
5+
# = \Pessimistic \Locking
6+
#
57
# Locking::Pessimistic provides support for row-level locking using
68
# SELECT ... FOR UPDATE and other lock types.
79
#

activerecord/lib/active_record/middleware/database_selector.rb

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -4,6 +4,8 @@
44

55
module ActiveRecord
66
module Middleware
7+
# = Database Selector \Middleware
8+
#
79
# The DatabaseSelector Middleware provides a framework for automatically
810
# swapping from the primary to the replica database connection. Rails
911
# provides a basic framework to determine when to swap and allows for

0 commit comments

Comments
 (0)