Tell one story through the batches README section - #12
Open
jpcamara wants to merge 3 commits into
Open
Conversation
The section opens by motivating batches with a row-by-row import, so the example is now that import: a batch described as nightly imports running ImportRowJobs, with callbacks named for when they run, each still logging a different counter. Drop the aside about callbacks receiving no arguments, which answered a question the section never raises—the configured-instance paragraph carries the arguments story. Anchor the upgrade instructions to version 1.7 so they date themselves. Co-Authored-By: Claude Fable 5 <noreply@anthropic.com>
Completion is detected from the batch's outstanding jobs, and most of the counters are computed at read time—the columns are only written when the batch finishes. Claiming the batch tracks progress with them described the reporting API as the mechanism. Co-Authored-By: Claude Fable 5 <noreply@anthropic.com>
The tables batches use was a noun pileup; say what the reader is missing and then what to run. Co-Authored-By: Claude Fable 5 <noreply@anthropic.com>
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
1 participant
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Ports the documentation improvements from the Active Job guide PR (jpcamara/rails#1) back to the README's batch section, applying the ones that fit the README's terser register.
What changed
ImportRowJobs, withImportFinishedJob/ImportSucceededJob/ImportFailedJobreplacing the sleepy placeholder jobs. Each callback still logs a different counter, and the example now includesdescription:, which the prose below refers to.def perform(batch)) or Sidekiq Pro's(status, options)callbacks would ask. The configured-instance paragraph two beats later (ImportSucceededJob.new("some argument")) carries the arguments story.What deliberately wasn't ported
The guide's "In the above example:" walkthrough and its one-idea-per-sentence pacing — that's the guide's teaching register; the README's compression is its own house style, and Rosa's membership bullets here already solve what the guide rework solved.
Content is otherwise unchanged: no factual claims added or removed.