Skip to content

Commit c567850

Browse files
authored
Merge pull request rails#47829 from p8/docs/headers-activejob
Use h1 for Active Job documentation titles [ci-skip]
2 parents 5ffaf41 + 31b94b1 commit c567850

16 files changed

+19
-13
lines changed

activejob/lib/active_job/base.rb

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -15,7 +15,7 @@
1515
require "active_job/translation"
1616

1717
module ActiveJob # :nodoc:
18-
# = Active Job
18+
# = Active Job \Base
1919
#
2020
# Active Job objects can be configured to work with different backend
2121
# queuing frameworks. To specify a queue adapter to use:

activejob/lib/active_job/callbacks.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/module/attribute_accessors"
55

66
module ActiveJob
7-
# = Active Job Callbacks
7+
# = Active Job \Callbacks
88
#
99
# Active Job provides hooks during the life cycle of a job. Callbacks allow you
1010
# to trigger logic during this cycle. Available callbacks are:

activejob/lib/active_job/core.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 ActiveJob
4+
# = Active Job \Core
5+
#
46
# Provides general behavior that will be included into every Active Job
57
# object that inherits from ActiveJob::Base.
68
module Core

activejob/lib/active_job/queue_adapter.rb

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -3,6 +3,8 @@
33
require "active_support/core_ext/string/inflections"
44

55
module ActiveJob
6+
# = Active Job Queue adapter
7+
#
68
# The <tt>ActiveJob::QueueAdapter</tt> module is used to load the
79
# correct adapter. The default queue adapter is the +:async+ queue.
810
module QueueAdapter # :nodoc:

activejob/lib/active_job/queue_adapters.rb

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
11
# frozen_string_literal: true
22

33
module ActiveJob
4-
# == Active Job adapters
4+
# = Active Job adapters
55
#
66
# Active Job has adapters for the following queuing backends:
77
#

activejob/lib/active_job/queue_adapters/async_adapter.rb

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

88
module ActiveJob
99
module QueueAdapters
10-
# == Active Job Async adapter
10+
# = Active Job Async adapter
1111
#
1212
# The Async adapter runs jobs with an in-process thread pool.
1313
#

activejob/lib/active_job/queue_adapters/backburner_adapter.rb

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

55
module ActiveJob
66
module QueueAdapters
7-
# == Backburner adapter for Active Job
7+
# = Backburner adapter for Active Job
88
#
99
# Backburner is a beanstalkd-powered job queue that can handle a very
1010
# high volume of jobs. You create background jobs and place them on

activejob/lib/active_job/queue_adapters/delayed_job_adapter.rb

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

66
module ActiveJob
77
module QueueAdapters
8-
# == Delayed Job adapter for Active Job
8+
# = Delayed Job adapter for Active Job
99
#
1010
# Delayed::Job (or DJ) encapsulates the common pattern of asynchronously
1111
# executing longer tasks in the background. Although DJ can have many

activejob/lib/active_job/queue_adapters/inline_adapter.rb

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

33
module ActiveJob
44
module QueueAdapters
5-
# == Active Job Inline adapter
5+
# = Active Job Inline adapter
66
#
77
# When enqueuing jobs with the Inline adapter the job will be executed
88
# immediately.

activejob/lib/active_job/queue_adapters/queue_classic_adapter.rb

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

55
module ActiveJob
66
module QueueAdapters
7-
# == queue_classic adapter for Active Job
7+
# = queue_classic adapter for Active Job
88
#
99
# queue_classic provides a simple interface to a PostgreSQL-backed message
1010
# queue. queue_classic specializes in concurrent locking and minimizing

0 commit comments

Comments
 (0)