You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
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.
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!
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.
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
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.
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
✏️ Tip: You can customize this high-level summary in your review settings.