1
0
Fork 0
mirror of https://github.com/rails/rails.git synced 2022-11-09 12:12:34 -05:00

Merge pull request #34481 from jacobherrington/patch-1

Correct a spelling error
This commit is contained in:
Gannon McGibbon 2018-11-19 00:07:57 -05:00 committed by GitHub
commit 2201197961
No known key found for this signature in database
GPG key ID: 4AEE18F83AFDEB23
9 changed files with 15 additions and 15 deletions

View file

@ -45,7 +45,7 @@ or to generate the body of an email. In Rails, View generation is handled by [Ac
[Active Record](activerecord/README.rdoc), [Active Model](activemodel/README.rdoc), [Action Pack](actionpack/README.rdoc), and [Action View](actionview/README.rdoc) can each be used independently outside Rails. [Active Record](activerecord/README.rdoc), [Active Model](activemodel/README.rdoc), [Action Pack](actionpack/README.rdoc), and [Action View](actionview/README.rdoc) can each be used independently outside Rails.
In addition to that, Rails also comes with [Action Mailer](actionmailer/README.rdoc), a library In addition to that, Rails also comes with [Action Mailer](actionmailer/README.rdoc), a library
to generate and send emails; [Active Job](activejob/README.md), a to generate and send emails; [Active Job](activejob/README.md), a
framework for declaring jobs and making them run on a variety of queueing framework for declaring jobs and making them run on a variety of queuing
backends; [Action Cable](actioncable/README.md), a framework to backends; [Action Cable](actioncable/README.md), a framework to
integrate WebSockets with a Rails application; [Active Storage](activestorage/README.md), a library to attach cloud integrate WebSockets with a Rails application; [Active Storage](activestorage/README.md), a library to attach cloud
and local files to Rails applications; and local files to Rails applications;

View file

@ -1,7 +1,7 @@
# Active Job -- Make work happen later # Active Job -- Make work happen later
Active Job is a framework for declaring jobs and making them run on a variety Active Job is a framework for declaring jobs and making them run on a variety
of queueing backends. These jobs can be everything from regularly scheduled of queuing backends. These jobs can be everything from regularly scheduled
clean-ups, to billing charges, to mailings. Anything that can be chopped up into clean-ups, to billing charges, to mailings. Anything that can be chopped up into
small units of work and run in parallel, really. small units of work and run in parallel, really.
@ -20,7 +20,7 @@ switch between them without having to rewrite your jobs.
## Usage ## Usage
To learn how to use your preferred queueing backend see its adapter To learn how to use your preferred queuing backend see its adapter
documentation at documentation at
[ActiveJob::QueueAdapters](http://api.rubyonrails.org/classes/ActiveJob/QueueAdapters.html). [ActiveJob::QueueAdapters](http://api.rubyonrails.org/classes/ActiveJob/QueueAdapters.html).
@ -39,7 +39,7 @@ end
Enqueue a job like so: Enqueue a job like so:
```ruby ```ruby
MyJob.perform_later record # Enqueue a job to be performed as soon as the queueing system is free. MyJob.perform_later record # Enqueue a job to be performed as soon as the queuing system is free.
``` ```
```ruby ```ruby
@ -82,9 +82,9 @@ This works with any class that mixes in GlobalID::Identification, which
by default has been mixed into Active Record classes. by default has been mixed into Active Record classes.
## Supported queueing systems ## Supported queuing systems
Active Job has built-in adapters for multiple queueing backends (Sidekiq, Active Job has built-in adapters for multiple queuing backends (Sidekiq,
Resque, Delayed Job and others). To get an up-to-date list of the adapters Resque, Delayed Job and others). To get an up-to-date list of the adapters
see the API Documentation for [ActiveJob::QueueAdapters](http://api.rubyonrails.org/classes/ActiveJob/QueueAdapters.html). see the API Documentation for [ActiveJob::QueueAdapters](http://api.rubyonrails.org/classes/ActiveJob/QueueAdapters.html).

View file

@ -7,7 +7,7 @@ Gem::Specification.new do |s|
s.name = "activejob" s.name = "activejob"
s.version = version s.version = version
s.summary = "Job framework with pluggable queues." s.summary = "Job framework with pluggable queues."
s.description = "Declare job classes that can be run by a variety of queueing backends." s.description = "Declare job classes that can be run by a variety of queuing backends."
s.required_ruby_version = ">= 2.4.1" s.required_ruby_version = ">= 2.4.1"

View file

@ -40,7 +40,7 @@ module ActiveJob #:nodoc:
# Records that are passed in are serialized/deserialized using Global # Records that are passed in are serialized/deserialized using Global
# ID. More information can be found in Arguments. # ID. More information can be found in Arguments.
# #
# To enqueue a job to be performed as soon as the queueing system is free: # To enqueue a job to be performed as soon as the queuing system is free:
# #
# ProcessPhotoJob.perform_later(photo) # ProcessPhotoJob.perform_later(photo)
# #

View file

@ -130,7 +130,7 @@ module ActiveJob
set_callback(:enqueue, :after, *filters, &blk) set_callback(:enqueue, :after, *filters, &blk)
end end
# Defines a callback that will get called around the enqueueing # Defines a callback that will get called around the enqueuing
# of the job. # of the job.
# #
# class VideoProcessJob < ActiveJob::Base # class VideoProcessJob < ActiveJob::Base

View file

@ -78,7 +78,7 @@ module ActiveJob
end end
# Returns a hash with the job data that can safely be passed to the # Returns a hash with the job data that can safely be passed to the
# queueing adapter. # queuing adapter.
def serialize def serialize
{ {
"job_class" => self.class.name, "job_class" => self.class.name,

View file

@ -26,7 +26,7 @@ module ActiveJob
end end
end end
# Performs the job immediately. The job is not sent to the queueing adapter # Performs the job immediately. The job is not sent to the queuing adapter
# but directly executed by blocking the execution of others until it's finished. # but directly executed by blocking the execution of others until it's finished.
# #
# MyJob.new(*args).perform_now # MyJob.new(*args).perform_now

View file

@ -3,7 +3,7 @@
module ActiveJob module ActiveJob
# == Active Job adapters # == Active Job adapters
# #
# Active Job has adapters for the following queueing backends: # Active Job has adapters for the following queuing backends:
# #
# * {Backburner}[https://github.com/nesquena/backburner] # * {Backburner}[https://github.com/nesquena/backburner]
# * {Delayed Job}[https://github.com/collectiveidea/delayed_job] # * {Delayed Job}[https://github.com/collectiveidea/delayed_job]
@ -52,7 +52,7 @@ module ActiveJob
# #
# No: The adapter will run jobs at the next opportunity and cannot use perform_later. # No: The adapter will run jobs at the next opportunity and cannot use perform_later.
# #
# N/A: The adapter does not support queueing. # N/A: The adapter does not support queuing.
# #
# NOTE: # NOTE:
# queue_classic supports job scheduling since version 3.1. # queue_classic supports job scheduling since version 3.1.
@ -74,7 +74,7 @@ module ActiveJob
# #
# No: Does not allow the priority of jobs to be configured. # No: Does not allow the priority of jobs to be configured.
# #
# N/A: The adapter does not support queueing, and therefore sorting them. # N/A: The adapter does not support queuing, and therefore sorting them.
# #
# ==== Timeout # ==== Timeout
# #

View file

@ -731,7 +731,7 @@ There are a few configuration options available in Active Support:
`config.active_job` provides the following configuration options: `config.active_job` provides the following configuration options:
* `config.active_job.queue_adapter` sets the adapter for the queueing backend. The default adapter is `:async`. For an up-to-date list of built-in adapters see the [ActiveJob::QueueAdapters API documentation](http://api.rubyonrails.org/classes/ActiveJob/QueueAdapters.html). * `config.active_job.queue_adapter` sets the adapter for the queuing backend. The default adapter is `:async`. For an up-to-date list of built-in adapters see the [ActiveJob::QueueAdapters API documentation](http://api.rubyonrails.org/classes/ActiveJob/QueueAdapters.html).
```ruby ```ruby
# Be sure to have the adapter's gem in your Gemfile # Be sure to have the adapter's gem in your Gemfile