docs: document GridSpec's preprocess_*_batch methods - #76
Merged
Conversation
#75 added preprocess_geotiff_batch()/preprocess_netcdf_batch()/ preprocess_csv_batch() to GridSpec but the preprocessing tutorial -- the primary place these methods are introduced to users -- only covered the local preprocess_*() calls. Adds a "Batch dispatch (remote)" subsection under "Step 7: GridSpec-Based Preprocessing" showing the swap from a local call to its _batch() counterpart, updates the "When to Use Which" callout table with the batch row, and adds a line to the tutorial's summary. llms-full.txt already covered this in #75. Co-Authored-By: Claude Sonnet 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.
Summary
Follow-up to #75 (merged) — that PR added
GridSpec.preprocess_geotiff_batch()/preprocess_netcdf_batch()/preprocess_csv_batch()and documented them inllms-full.txt, but the preprocessing tutorial (docs/tutorials/preprocessing.qmd), which is where these methods are actually introduced to users via "Step 7: GridSpec-Based Preprocessing," only covered the localpreprocess_*()calls._batch()counterpart (same output-path/variant/template_path/temporal-axis semantics, justtargetrequired pluspoll_interval/timeout).No API reference (quartodoc) changes needed —
GridSpecisn't indocs/_quarto.yml's reference nav at all (a pre-existing gap predating both this PR and #75, out of scope here).Test plan
pixi run docs-build— renders cleanly (78 reference pages, no warnings on this file);docs/_freeze,docs/objects.json, anddocs/reference/index.qmdare all unchanged (prose-only edit, no new API surface)🤖 Generated with Claude Code