Skip to content

Commit ec28de4

Browse files
committed
Add missing headers to Active Support docs [ci-skip]
Having a h1 heading will improve SEO and makes things look more consistent.
1 parent ea7ac15 commit ec28de4

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

46 files changed

+95
-4
lines changed

activesupport/lib/active_support/actionable_error.rb

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

33
module ActiveSupport
4+
# = Actionable Errors
5+
#
46
# Actionable errors lets you define actions to resolve an error.
57
#
68
# To make an error actionable, include the <tt>ActiveSupport::ActionableError</tt>

activesupport/lib/active_support/array_inquirer.rb

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

33
module ActiveSupport
4+
# = \Array Inquirer
5+
#
46
# Wrapping an array in an +ArrayInquirer+ gives a friendlier way to check
57
# its string-like contents:
68
#

activesupport/lib/active_support/backtrace_cleaner.rb

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

33
module ActiveSupport
4+
# = Backtrace Cleaner
5+
#
46
# Backtraces often include many lines that are not relevant for the context
57
# under review. This makes it hard to find the signal amongst the backtrace
68
# noise, and adds debugging time. With a BacktraceCleaner, filters and

activesupport/lib/active_support/benchmarkable.rb

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

66
module ActiveSupport
7+
# = \Benchmarkable
78
module Benchmarkable
89
# Allows you to measure the execution time of a block in a template and
910
# records the result to the log. Wrap this block around expensive operations

activesupport/lib/active_support/cache.rb

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -130,6 +130,8 @@ def retrieve_store_class(store)
130130
end
131131
end
132132

133+
# = Active Support \Cache \Store
134+
#
133135
# An abstract cache store class. There are multiple cache store
134136
# implementations, each having its own additional features. See the classes
135137
# under the ActiveSupport::Cache module, e.g.

activesupport/lib/active_support/cache/file_store.rb

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

77
module ActiveSupport
88
module Cache
9+
# = \File \Cache \Store
10+
#
911
# A cache store implementation which stores everything on the filesystem.
1012
class FileStore < Store
1113
attr_reader :cache_path

activesupport/lib/active_support/cache/mem_cache_store.rb

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

1616
module ActiveSupport
1717
module Cache
18+
# = Memcached \Cache \Store
19+
#
1820
# A cache store implementation which stores data in Memcached:
1921
# https://memcached.org
2022
#

activesupport/lib/active_support/cache/memory_store.rb

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

55
module ActiveSupport
66
module Cache
7+
# = Memory \Cache \Store
8+
#
79
# A cache store implementation which stores everything into memory in the
810
# same process. If you're running multiple Ruby on Rails server processes
911
# (which is the case if you're using Phusion Passenger or puma clustered mode),

activesupport/lib/active_support/cache/null_store.rb

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

33
module ActiveSupport
44
module Cache
5+
# = Null \Cache \Store
6+
#
57
# A cache store implementation which doesn't actually store anything. Useful in
68
# development and test environments where you don't want caching turned on but
79
# need to go through the caching interface.

activesupport/lib/active_support/cache/redis_cache_store.rb

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

1616
module ActiveSupport
1717
module Cache
18-
# Redis cache store.
18+
# = Redis \Cache \Store
1919
#
2020
# Deployment note: Take care to use a *dedicated Redis cache* rather
2121
# than pointing this at your existing Redis server. It won't cope well

0 commit comments

Comments
 (0)