Skip to content

Commit

Permalink
Merge pull request #47828 from p8/docs/headers-activemodel
Browse files Browse the repository at this point in the history
Use h1 for Active Model documentation titles [ci-skip]
  • Loading branch information
p8 committed Apr 1, 2023
2 parents 08203b8 + f8e5dab commit 5ffaf41
Show file tree
Hide file tree
Showing 14 changed files with 16 additions and 14 deletions.
2 changes: 1 addition & 1 deletion activemodel/lib/active_model/api.rb
@@ -1,7 +1,7 @@
# frozen_string_literal: true

module ActiveModel
# == Active \Model \API
# = Active \Model \API
#
# Includes the required interface for an object to interact with
# Action Pack and Action View, using different Active Model modules.
Expand Down
2 changes: 1 addition & 1 deletion activemodel/lib/active_model/attribute_methods.rb
Expand Up @@ -15,7 +15,7 @@ module ActiveModel
class MissingAttributeError < NoMethodError
end

# == Active \Model \Attribute \Methods
# = Active \Model \Attribute \Methods
#
# Provides a way to add prefixes and suffixes to your methods as
# well as handling the creation of <tt>ActiveRecord::Base</tt>-like
Expand Down
2 changes: 2 additions & 0 deletions activemodel/lib/active_model/attributes.rb
@@ -1,6 +1,8 @@
# frozen_string_literal: true

module ActiveModel
# = Active \Model \Attributes
#
# The Attributes module allows models to define attributes beyond simple Ruby
# readers and writers. Similar to Active Record attributes, which are
# typically inferred from the database schema, Active Model Attributes are
Expand Down
2 changes: 1 addition & 1 deletion activemodel/lib/active_model/callbacks.rb
Expand Up @@ -4,7 +4,7 @@
require "active_support/core_ext/hash/keys"

module ActiveModel
# == Active \Model \Callbacks
# = Active \Model \Callbacks
#
# Provides an interface for any class to have Active Record like callbacks.
#
Expand Down
2 changes: 1 addition & 1 deletion activemodel/lib/active_model/conversion.rb
@@ -1,7 +1,7 @@
# frozen_string_literal: true

module ActiveModel
# == Active \Model \Conversion
# = Active \Model \Conversion
#
# Handles default conversions: to_model, to_key, to_param, and to_partial_path.
#
Expand Down
2 changes: 1 addition & 1 deletion activemodel/lib/active_model/dirty.rb
Expand Up @@ -3,7 +3,7 @@
require "active_model/attribute_mutation_tracker"

module ActiveModel
# == Active \Model \Dirty
# = Active \Model \Dirty
#
# Provides a way to track changes in your object in the same way as
# Active Record does.
Expand Down
2 changes: 1 addition & 1 deletion activemodel/lib/active_model/errors.rb
Expand Up @@ -9,7 +9,7 @@
require "forwardable"

module ActiveModel
# == Active \Model \Errors
# = Active \Model \Errors
#
# Provides error related functionalities you can include in your object
# for handling error messages and interacting with Action View helpers.
Expand Down
2 changes: 1 addition & 1 deletion activemodel/lib/active_model/model.rb
@@ -1,7 +1,7 @@
# frozen_string_literal: true

module ActiveModel
# == Active \Model \Basic \Model
# = Active \Model \Basic \Model
#
# Allows implementing models similar to ActiveRecord::Base.
# Includes ActiveModel::API for the required interface for an
Expand Down
2 changes: 1 addition & 1 deletion activemodel/lib/active_model/serialization.rb
Expand Up @@ -3,7 +3,7 @@
require "active_support/core_ext/enumerable"

module ActiveModel
# == Active \Model \Serialization
# = Active \Model \Serialization
#
# Provides a basic serialization to a serializable_hash for your objects.
#
Expand Down
2 changes: 1 addition & 1 deletion activemodel/lib/active_model/serializers/json.rb
Expand Up @@ -4,7 +4,7 @@

module ActiveModel
module Serializers
# == Active \Model \JSON \Serializer
# = Active \Model \JSON \Serializer
module JSON
extend ActiveSupport::Concern
include ActiveModel::Serialization
Expand Down
2 changes: 1 addition & 1 deletion activemodel/lib/active_model/translation.rb
@@ -1,7 +1,7 @@
# frozen_string_literal: true

module ActiveModel
# == Active \Model \Translation
# = Active \Model \Translation
#
# Provides integration between your object and the Rails internationalization
# (i18n) framework.
Expand Down
4 changes: 2 additions & 2 deletions activemodel/lib/active_model/validations.rb
Expand Up @@ -3,7 +3,7 @@
require "active_support/core_ext/array/extract_options"

module ActiveModel
# == Active \Model \Validations
# = Active \Model \Validations
#
# Provides a full validation framework to your objects.
#
Expand Down Expand Up @@ -447,7 +447,7 @@ def raise_validation_error # :doc:
end
end

# = Active Model ValidationError
# = Active \Model \ValidationError
#
# Raised by <tt>validate!</tt> when the model is invalid. Use the
# +model+ method to retrieve the record which did not validate.
Expand Down
2 changes: 1 addition & 1 deletion activemodel/lib/active_model/validations/callbacks.rb
Expand Up @@ -2,7 +2,7 @@

module ActiveModel
module Validations
# == Active \Model \Validation \Callbacks
# = Active \Model \Validation \Callbacks
#
# Provides an interface for any class to have ClassMethods#before_validation and
# ClassMethods#after_validation callbacks.
Expand Down
2 changes: 1 addition & 1 deletion activemodel/lib/active_model/validator.rb
Expand Up @@ -3,7 +3,7 @@
require "active_support/core_ext/module/anonymous"

module ActiveModel
# == Active \Model \Validator
# = Active \Model \Validator
#
# A simple base class that can be used along with
# ActiveModel::Validations::ClassMethods.validates_with
Expand Down

0 comments on commit 5ffaf41

Please sign in to comment.