From 9fddcdd99eeaf6af8130d39a37d1e0aca080a33f Mon Sep 17 00:00:00 2001 From: Akshay Vishnoi Date: Thu, 18 Sep 2014 01:16:53 +0530 Subject: [PATCH] [ci skip] AJ docs fixes 1. Indentation 2. Spaces issues 3. Spelling correction 4. Grammar correction 5. Add #:nodoc: to all internal classes --- activejob/lib/active_job/callbacks.rb | 12 ++++++------ activejob/lib/active_job/core.rb | 2 +- activejob/lib/active_job/enqueuing.rb | 8 ++++---- activejob/lib/active_job/execution.rb | 2 +- activejob/lib/active_job/logging.rb | 2 +- .../active_job/queue_adapters/backburner_adapter.rb | 2 +- .../active_job/queue_adapters/delayed_job_adapter.rb | 2 +- .../lib/active_job/queue_adapters/qu_adapter.rb | 2 +- .../lib/active_job/queue_adapters/que_adapter.rb | 2 +- .../queue_adapters/queue_classic_adapter.rb | 2 +- .../lib/active_job/queue_adapters/resque_adapter.rb | 2 +- .../lib/active_job/queue_adapters/sidekiq_adapter.rb | 2 +- .../active_job/queue_adapters/sneakers_adapter.rb | 2 +- .../queue_adapters/sucker_punch_adapter.rb | 2 +- 14 files changed, 22 insertions(+), 22 deletions(-) diff --git a/activejob/lib/active_job/callbacks.rb b/activejob/lib/active_job/callbacks.rb index cafa3438c00..29e2a878b45 100644 --- a/activejob/lib/active_job/callbacks.rb +++ b/activejob/lib/active_job/callbacks.rb @@ -36,7 +36,7 @@ module ActiveJob # def perform(video_id) # Video.find(video_id).process # end - # end + # end # def before_perform(*filters, &blk) set_callback(:perform, :before, *filters, &blk) @@ -55,7 +55,7 @@ module ActiveJob # def perform(video_id) # Video.find(video_id).process # end - # end + # end # def after_perform(*filters, &blk) set_callback(:perform, :after, *filters, &blk) @@ -75,7 +75,7 @@ module ActiveJob # def perform(video_id) # Video.find(video_id).process # end - # end + # end # def around_perform(*filters, &blk) set_callback(:perform, :around, *filters, &blk) @@ -94,7 +94,7 @@ module ActiveJob # def perform(video_id) # Video.find(video_id).process # end - # end + # end # def before_enqueue(*filters, &blk) set_callback(:enqueue, :before, *filters, &blk) @@ -113,7 +113,7 @@ module ActiveJob # def perform(video_id) # Video.find(video_id).process # end - # end + # end # def after_enqueue(*filters, &blk) set_callback(:enqueue, :after, *filters, &blk) @@ -134,7 +134,7 @@ module ActiveJob # def perform(video_id) # Video.find(video_id).process # end - # end + # end # def around_enqueue(*filters, &blk) set_callback(:enqueue, :around, *filters, &blk) diff --git a/activejob/lib/active_job/core.rb b/activejob/lib/active_job/core.rb index b6dd03a0bcd..9db23cc9da1 100644 --- a/activejob/lib/active_job/core.rb +++ b/activejob/lib/active_job/core.rb @@ -13,7 +13,7 @@ module ActiveJob # Job Identifier attr_accessor :job_id - # Queue on which the job should be run on. + # Queue in which the job will reside. attr_writer :queue_name end diff --git a/activejob/lib/active_job/enqueuing.rb b/activejob/lib/active_job/enqueuing.rb index e8bc44cbc48..74bcc1fa5d9 100644 --- a/activejob/lib/active_job/enqueuing.rb +++ b/activejob/lib/active_job/enqueuing.rb @@ -5,9 +5,9 @@ module ActiveJob extend ActiveSupport::Concern module ClassMethods - # Push a job onto the queue. The arguments must be legal JSON types + # Push a job onto the queue. The arguments must be legal JSON types # (string, int, float, nil, true, false, hash or array) or - # GlobalID::Identification instances. Arbitrary Ruby objects + # GlobalID::Identification instances. Arbitrary Ruby objects # are not supported. # # Returns an instance of the job class queued with args available in @@ -22,7 +22,7 @@ module ActiveJob end end - # Reschedule the job to be re-executed. This is usefull in combination + # Reschedule the job to be re-executed. This is useful in combination # with the +rescue_from+ option. When you rescue an exception from your job # you can ask Active Job to retry performing your job. # @@ -45,7 +45,7 @@ module ActiveJob enqueue options end - # Equeue the job to be performed by the queue adapter. + # Enqueues the job to be performed by the queue adapter. # # ==== Options # * :wait - Enqueues the job with the specified delay diff --git a/activejob/lib/active_job/execution.rb b/activejob/lib/active_job/execution.rb index d6d67c46e38..7ff857206d1 100644 --- a/activejob/lib/active_job/execution.rb +++ b/activejob/lib/active_job/execution.rb @@ -22,7 +22,7 @@ module ActiveJob end # Performs the job immediately. The job is not sent to the queueing adapter - # and will block the execution until it's finished. + # but directly executed by blocking the execution of others until it's finished. # # MyJob.new(*args).perform_now def perform_now diff --git a/activejob/lib/active_job/logging.rb b/activejob/lib/active_job/logging.rb index 962005cd15c..bb96668cfb4 100644 --- a/activejob/lib/active_job/logging.rb +++ b/activejob/lib/active_job/logging.rb @@ -50,7 +50,7 @@ module ActiveJob logger.formatter.current_tags.include?("ActiveJob") end - class LogSubscriber < ActiveSupport::LogSubscriber + class LogSubscriber < ActiveSupport::LogSubscriber #:nodoc: def enqueue(event) info do job = event.payload[:job] diff --git a/activejob/lib/active_job/queue_adapters/backburner_adapter.rb b/activejob/lib/active_job/queue_adapters/backburner_adapter.rb index e1b00f1de77..a07a6fc2239 100644 --- a/activejob/lib/active_job/queue_adapters/backburner_adapter.rb +++ b/activejob/lib/active_job/queue_adapters/backburner_adapter.rb @@ -14,7 +14,7 @@ module ActiveJob end end - class JobWrapper + class JobWrapper #:nodoc: class << self def perform(job_data) Base.execute job_data diff --git a/activejob/lib/active_job/queue_adapters/delayed_job_adapter.rb b/activejob/lib/active_job/queue_adapters/delayed_job_adapter.rb index 658799edfcc..30c535f3b4b 100644 --- a/activejob/lib/active_job/queue_adapters/delayed_job_adapter.rb +++ b/activejob/lib/active_job/queue_adapters/delayed_job_adapter.rb @@ -13,7 +13,7 @@ module ActiveJob end end - class JobWrapper + class JobWrapper #:nodoc: def perform(job_data) Base.execute(job_data) end diff --git a/activejob/lib/active_job/queue_adapters/qu_adapter.rb b/activejob/lib/active_job/queue_adapters/qu_adapter.rb index f681fd7e8a7..5485f206891 100644 --- a/activejob/lib/active_job/queue_adapters/qu_adapter.rb +++ b/activejob/lib/active_job/queue_adapters/qu_adapter.rb @@ -15,7 +15,7 @@ module ActiveJob end end - class JobWrapper < Qu::Job + class JobWrapper < Qu::Job #:nodoc: def initialize(job_data) @job_data = job_data end diff --git a/activejob/lib/active_job/queue_adapters/que_adapter.rb b/activejob/lib/active_job/queue_adapters/que_adapter.rb index 51891ab07b3..2e8a64aa87e 100644 --- a/activejob/lib/active_job/queue_adapters/que_adapter.rb +++ b/activejob/lib/active_job/queue_adapters/que_adapter.rb @@ -13,7 +13,7 @@ module ActiveJob end end - class JobWrapper < Que::Job + class JobWrapper < Que::Job #:nodoc: def run(job_data) Base.execute job_data end diff --git a/activejob/lib/active_job/queue_adapters/queue_classic_adapter.rb b/activejob/lib/active_job/queue_adapters/queue_classic_adapter.rb index ddcc8683177..e8452938b88 100644 --- a/activejob/lib/active_job/queue_adapters/queue_classic_adapter.rb +++ b/activejob/lib/active_job/queue_adapters/queue_classic_adapter.rb @@ -28,7 +28,7 @@ module ActiveJob end end - class JobWrapper + class JobWrapper #:nodoc: class << self def perform(job_data) Base.execute job_data diff --git a/activejob/lib/active_job/queue_adapters/resque_adapter.rb b/activejob/lib/active_job/queue_adapters/resque_adapter.rb index affa3bdfbca..b1bc2f15eed 100644 --- a/activejob/lib/active_job/queue_adapters/resque_adapter.rb +++ b/activejob/lib/active_job/queue_adapters/resque_adapter.rb @@ -29,7 +29,7 @@ module ActiveJob end end - class JobWrapper + class JobWrapper #:nodoc: class << self def perform(job_data) Base.execute job_data diff --git a/activejob/lib/active_job/queue_adapters/sidekiq_adapter.rb b/activejob/lib/active_job/queue_adapters/sidekiq_adapter.rb index 79926a1e242..6d351172de3 100644 --- a/activejob/lib/active_job/queue_adapters/sidekiq_adapter.rb +++ b/activejob/lib/active_job/queue_adapters/sidekiq_adapter.rb @@ -23,7 +23,7 @@ module ActiveJob end end - class JobWrapper + class JobWrapper #:nodoc: include Sidekiq::Worker def perform(job_data) diff --git a/activejob/lib/active_job/queue_adapters/sneakers_adapter.rb b/activejob/lib/active_job/queue_adapters/sneakers_adapter.rb index 1ab0a874855..91658e08f06 100644 --- a/activejob/lib/active_job/queue_adapters/sneakers_adapter.rb +++ b/activejob/lib/active_job/queue_adapters/sneakers_adapter.rb @@ -19,7 +19,7 @@ module ActiveJob end end - class JobWrapper + class JobWrapper #:nodoc: include Sneakers::Worker from_queue 'default' diff --git a/activejob/lib/active_job/queue_adapters/sucker_punch_adapter.rb b/activejob/lib/active_job/queue_adapters/sucker_punch_adapter.rb index b19a38093fd..68aa58cadb7 100644 --- a/activejob/lib/active_job/queue_adapters/sucker_punch_adapter.rb +++ b/activejob/lib/active_job/queue_adapters/sucker_punch_adapter.rb @@ -13,7 +13,7 @@ module ActiveJob end end - class JobWrapper + class JobWrapper #:nodoc: include SuckerPunch::Job def perform(job_data)