[RF] Move former RooChi2Var documentation to RooAbsReal::createChi2()#21700
Merged
guitargeek merged 3 commits intoroot-project:masterfrom Mar 28, 2026
Merged
[RF] Move former RooChi2Var documentation to RooAbsReal::createChi2()#21700guitargeek merged 3 commits intoroot-project:masterfrom
RooAbsReal::createChi2()#21700guitargeek merged 3 commits intoroot-project:masterfrom
Conversation
dpiparo
approved these changes
Mar 26, 2026
Contributor
|
Thanks @guitargeek , I think we should also show the list of supported arguments (and their defaults). The extended mode and data error defaults to AUTO but it is not immediately clear to users what AUTO will evaluate to without looking at the source codes. (i.e. data error will use SumW2 if it is not poisson weighted, otherwise it uses Expected) |
In some environments, like on NixOS, `bash` is not directly in `/usr/bin/`. Use `env` to resolve the location of bash in the general case.
The class an implementation detail that is hidden from the user, and the entry point for chi-square test statistics is `RooAbsReal::createChi2()`. This is where the documentation belongs. Tested locally that the rendered doxygen is correct. Closes root-project#21699.
guitargeek
force-pushed
the
issue-21699
branch
2 times, most recently
from
54efcfa to
dc8310e
Compare
AlkaidCheng
reviewed
Mar 27, 2026
Before, the docs were scattered around different overloads, making it easy to miss the documentation for the commands that were only included in one of the docstring (like for `DataError`).
Test Results 20 files 20 suites 2d 20h 42m 4s ⏱️ Results for commit 102044e. |
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
3 participants
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.
The class an implementation detail that is hidden from the user, and the entry point for chi-square test statistics is
RooAbsReal::createChi2(). This is where the documentation belongs.Tested locally that the rendered doxygen is correct.
Closes #21699.