Add YAML example to every step reference entry#105
Merged
Conversation
Each step and the combine_runs reduction now carries a short YAML snippet showing a typical invocation, so every entry has one.
There was a problem hiding this comment.
Pull request overview
This PR updates the Step Reference documentation to consistently include a short YAML usage snippet for each step/reduction entry, improving discoverability and “copy/paste” usability across the docs.
Changes:
- Added YAML invocation examples for step entries across all four step-category pages.
- Added a YAML example for the
combine_runscross-run reduction under thereduction:section.
Reviewed changes
Copilot reviewed 4 out of 4 changed files in this pull request and generated no comments.
| File | Description |
|---|---|
| docs/steps/loading_filtering.md | Adds YAML snippets for loading and shot-selection steps (e.g., loading keys/detectors, mask construction, filtering). |
| docs/steps/detector.md | Adds YAML snippets for detector correction/geometry/reduction steps (e.g., patching pixels, ROI, spatial/shot reductions). |
| docs/steps/binning.md | Adds YAML snippets for axis/bin-index builders and binned reductions (temporal/energy/2D). |
| docs/steps/spectra.md | Adds YAML snippets for spectra utilities and the combine_runs reduction under reduction:. |
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
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
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.
What changed
Every step entry in the Step reference now carries a short YAML snippet
showing a typical invocation. Previously only a handful had examples.
Covers all four category pages (loading & filtering, detector & spatial,
binning, spectra & reductions), plus the
combine_runsreduction.Test
mkdocs buildrenders all pages with no broken-link warnings.