Skip to content

Add YAML example to every step reference entry#105

Merged
lg345 merged 1 commit into
masterfrom
docs/step-examples
Jul 17, 2026
Merged

Add YAML example to every step reference entry#105
lg345 merged 1 commit into
masterfrom
docs/step-examples

Conversation

@lg345

@lg345 lg345 commented Jul 17, 2026

Copy link
Copy Markdown
Owner

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_runs reduction.

Test

mkdocs build renders all pages with no broken-link warnings.

Each step and the combine_runs reduction now carries a short YAML snippet
showing a typical invocation, so every entry has one.
Copilot AI review requested due to automatic review settings July 17, 2026 07:52

Copilot AI left a comment

Copy link
Copy Markdown

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

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_runs cross-run reduction under the reduction: 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.

@lg345
lg345 merged commit 395b468 into master Jul 17, 2026
1 check passed
@lg345
lg345 deleted the docs/step-examples branch July 17, 2026 07:57
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

3 participants