Skip to content

Clarify use of -D for loading toys#1201

Merged
nucleosynthesis merged 3 commits intomainfrom
adewit-toy-clarification
Jan 29, 2026
Merged

Clarify use of -D for loading toys#1201
nucleosynthesis merged 3 commits intomainfrom
adewit-toy-clarification

Conversation

@adewit
Copy link
Copy Markdown
Collaborator

@adewit adewit commented Jan 28, 2026

For frequentist toys, fitting a specific toy by passing it as the dataset to run on does not work correctly as the global observables are not loaded in this case. This is now clarified in the documentation.

Summary by CodeRabbit

  • Documentation
    • Updated toy-generation guidance: replaced the old single-toy example with a workflow using --toysFile plus --pickToy N to select a specific toy. Clarified that frequentist toys must be run via --toysFile (passing a toy as an alternate dataset will not load randomized constraint terms). Preserved surrounding warnings and recommendations for working with previously generated toy files.

✏️ Tip: You can customize this high-level summary in your review settings.

@coderabbitai
Copy link
Copy Markdown
Contributor

coderabbitai bot commented Jan 28, 2026

📝 Walkthrough

Walkthrough

Updated "Running the Tool" documentation to replace the single-toy -D example with guidance to use --toysFile plus --pickToy N for selecting a toy; notes that frequentist toys must use --toysFile because -D won't load randomized constraint terms. (≤50 words)

Changes

Cohort / File(s) Summary
Documentation update
docs/part3/runningthetool.md
Replaced single-toy -D invocation example with workflow using --toysFile and --pickToy N; added explicit note that frequentist toys require --toysFile since -D will not load randomized constraint terms.

Estimated code review effort

🎯 1 (Trivial) | ⏱️ ~2 minutes

Possibly related PRs

  • Add option to pick toy #1200 — Adds --pickToy support and corresponding Combine::setPickToy logic, directly related to the new doc guidance about selecting a specific toy.

Poem

🐰 A curious rabbit hops in delight,
Found --toysFile shining bright tonight.
If toys are frequentist, don't use -D alone,
Pick with --pickToy so constraints are shown.
Hoppity joy — documentation neatly sewn!

🚥 Pre-merge checks | ✅ 3
✅ Passed checks (3 passed)
Check name Status Explanation
Description Check ✅ Passed Check skipped - CodeRabbit’s high-level summary is enabled.
Title check ✅ Passed The title directly addresses the main change: clarifying the use of the -D flag for loading toys in the documentation, which is the core objective of this PR.
Docstring Coverage ✅ Passed No functions found in the changed files to evaluate docstring coverage. Skipping docstring coverage check.

✏️ Tip: You can configure your own custom pre-merge checks in the settings.


Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out.

❤️ Share

Comment @coderabbitai help to get the list of available commands and usage tips.

@nucleosynthesis nucleosynthesis merged commit 01245a6 into main Jan 29, 2026
3 checks passed
@nucleosynthesis nucleosynthesis deleted the adewit-toy-clarification branch January 29, 2026 11:21
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.

2 participants