Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Use h1 for Active Job documentation titles [ci-skip] #47829

Merged
merged 1 commit into from
Apr 1, 2023
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Jump to
Jump to file
Failed to load files.
Diff view
Diff view
2 changes: 1 addition & 1 deletion activejob/lib/active_job/base.rb
Original file line number Diff line number Diff line change
Expand Up @@ -15,7 +15,7 @@
require "active_job/translation"

module ActiveJob # :nodoc:
# = Active Job
# = Active Job \Base
#
# Active Job objects can be configured to work with different backend
# queuing frameworks. To specify a queue adapter to use:
Expand Down
2 changes: 1 addition & 1 deletion activejob/lib/active_job/callbacks.rb
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,7 @@
require "active_support/core_ext/module/attribute_accessors"

module ActiveJob
# = Active Job Callbacks
# = Active Job \Callbacks
#
# Active Job provides hooks during the life cycle of a job. Callbacks allow you
# to trigger logic during this cycle. Available callbacks are:
Expand Down
2 changes: 2 additions & 0 deletions activejob/lib/active_job/core.rb
Original file line number Diff line number Diff line change
@@ -1,6 +1,8 @@
# frozen_string_literal: true

module ActiveJob
# = Active Job \Core
#
# Provides general behavior that will be included into every Active Job
# object that inherits from ActiveJob::Base.
module Core
Expand Down
2 changes: 2 additions & 0 deletions activejob/lib/active_job/queue_adapter.rb
Original file line number Diff line number Diff line change
Expand Up @@ -3,6 +3,8 @@
require "active_support/core_ext/string/inflections"

module ActiveJob
# = Active Job Queue adapter
#
# The <tt>ActiveJob::QueueAdapter</tt> module is used to load the
# correct adapter. The default queue adapter is the +:async+ queue.
module QueueAdapter # :nodoc:
Expand Down
2 changes: 1 addition & 1 deletion activejob/lib/active_job/queue_adapters.rb
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
# frozen_string_literal: true

module ActiveJob
# == Active Job adapters
# = Active Job adapters
#
# Active Job has adapters for the following queuing backends:
#
Expand Down
2 changes: 1 addition & 1 deletion activejob/lib/active_job/queue_adapters/async_adapter.rb
Original file line number Diff line number Diff line change
Expand Up @@ -7,7 +7,7 @@

module ActiveJob
module QueueAdapters
# == Active Job Async adapter
# = Active Job Async adapter
#
# The Async adapter runs jobs with an in-process thread pool.
#
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,7 @@

module ActiveJob
module QueueAdapters
# == Backburner adapter for Active Job
# = Backburner adapter for Active Job
#
# Backburner is a beanstalkd-powered job queue that can handle a very
# high volume of jobs. You create background jobs and place them on
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -5,7 +5,7 @@

module ActiveJob
module QueueAdapters
# == Delayed Job adapter for Active Job
# = Delayed Job adapter for Active Job
#
# Delayed::Job (or DJ) encapsulates the common pattern of asynchronously
# executing longer tasks in the background. Although DJ can have many
Expand Down
2 changes: 1 addition & 1 deletion activejob/lib/active_job/queue_adapters/inline_adapter.rb
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@

module ActiveJob
module QueueAdapters
# == Active Job Inline adapter
# = Active Job Inline adapter
#
# When enqueuing jobs with the Inline adapter the job will be executed
# immediately.
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,7 @@

module ActiveJob
module QueueAdapters
# == queue_classic adapter for Active Job
# = queue_classic adapter for Active Job
#
# queue_classic provides a simple interface to a PostgreSQL-backed message
# queue. queue_classic specializes in concurrent locking and minimizing
Expand Down
2 changes: 1 addition & 1 deletion activejob/lib/active_job/queue_adapters/resque_adapter.rb
Original file line number Diff line number Diff line change
Expand Up @@ -16,7 +16,7 @@

module ActiveJob
module QueueAdapters
# == Resque adapter for Active Job
# = Resque adapter for Active Job
#
# Resque (pronounced like "rescue") is a Redis-backed library for creating
# background jobs, placing those jobs on multiple queues, and processing
Expand Down
2 changes: 1 addition & 1 deletion activejob/lib/active_job/queue_adapters/sidekiq_adapter.rb
Original file line number Diff line number Diff line change
Expand Up @@ -5,7 +5,7 @@

module ActiveJob
module QueueAdapters
# == Sidekiq adapter for Active Job
# = Sidekiq adapter for Active Job
#
# Simple, efficient background processing for Ruby. Sidekiq uses threads to
# handle many jobs at the same time in the same process. It does not
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -5,7 +5,7 @@

module ActiveJob
module QueueAdapters
# == Sneakers adapter for Active Job
# = Sneakers adapter for Active Job
#
# A high-performance RabbitMQ background processing framework for Ruby.
# Sneakers is being used in production for both I/O and CPU intensive
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,7 @@

module ActiveJob
module QueueAdapters
# == Sucker Punch adapter for Active Job
# = Sucker Punch adapter for Active Job
#
# Sucker Punch is a single-process Ruby asynchronous processing library.
# This reduces the cost of hosting on a service like Heroku along
Expand Down
2 changes: 1 addition & 1 deletion activejob/lib/active_job/queue_adapters/test_adapter.rb
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@

module ActiveJob
module QueueAdapters
# == Test adapter for Active Job
# = Test adapter for Active Job
#
# The test adapter should be used only in testing. Along with
# ActiveJob::TestCase and ActiveJob::TestHelper
Expand Down
2 changes: 2 additions & 0 deletions activejob/lib/active_job/serializers.rb
Original file line number Diff line number Diff line change
Expand Up @@ -3,6 +3,8 @@
require "set"

module ActiveJob
# = Active Job \Serializers
#
# The <tt>ActiveJob::Serializers</tt> module is used to store a list of known serializers
# and to add new ones. It also has helpers to serialize/deserialize objects.
module Serializers # :nodoc:
Expand Down