📝 Add docstrings to CaloValid-OO-update

[coderabbitai]

Docstrings generation was requested by @pinkenburg.

• CaloValid - O+O Update #4145 (comment)

The following files were modified:

• offline/QA/Calorimeters/CaloValid.cc
• offline/framework/phool/RunnumberRange.h

ℹ️ Note

CodeRabbit cannot perform edits on its own pull requests yet.

[coderabbitai]

Important

Review skipped

This PR was authored by the user configured for CodeRabbit reviews. By default, CodeRabbit skips reviewing PRs authored by this user. It's recommended to use a dedicated user account to post CodeRabbit review feedback.

To trigger a single review, invoke the @coderabbitai review command.

You can disable this status message by setting the reviews.review_status to false in the CodeRabbit configuration file.

• 🔍 Trigger a full review

---

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

[pinkenburg]

it's just comments - merging before jenkins is done

[sphenix-jenkins-ci]

Build & test report

Report for commit 72f7c46d28be735247d81cb0e1bfd45a206e44bb:

• builds and tests overall are FAILURE.
• Build with configuration of alma9.2-gcc-14.2.0 / clang is SUCCESS, 📊clang report (full)/(new), build log
• Build with configuration of alma9.2-gcc-14.2.0 / new is FAILURE, 📊Compiler report (full)/(new), build log
  • Generating DST and readback: build is SUCCESS
  • Calorimeter QA: build is SUCCESS, 📊 trends
    • 📊 QA-calorimeter for e- at p_T=4GeV : combined Chi2/nDoF = 27.45 / 72, and combined p-Value = 1
    • 📊 QA-calorimeter for pi+ at p_T=30GeV : combined Chi2/nDoF = 41.7331 / 72, and combined p-Value = 0.99837
    • 📊 QA-calorimetric-jet for e- at p_T=4GeV : combined Chi2/nDoF = 0.4559 / 42, and combined p-Value = 1
    • 📊 QA-calorimetric-jet for pi+ at p_T=30GeV : combined Chi2/nDoF = 14.2531 / 42, and combined p-Value = 0.999981
  • Tracking QA with Distortions: build is SUCCESS, 📊 trends
    • 📊 QA-distortions
  • Tracking QA at low occupancy: build is SUCCESS, 📊 trends
    • 📊 QA-Intt : combined Chi2/nDoF = -0 / 72, and combined p-Value = 1
    • 📊 QA-Micromegas : combined Chi2/nDoF = -0 / 20, and combined p-Value = 1
    • 📊 QA-Mvtx : combined Chi2/nDoF = -0 / 54, and combined p-Value = 1
    • 📊 QA-Tpc : combined Chi2/nDoF = -0 / 56, and combined p-Value = 1
    • 📊 QA-tracking : combined Chi2/nDoF = 0.00798791 / 56, and combined p-Value = 1
    • 📊 QA-vertexing : combined Chi2/nDoF = 40.6851 / 112, and combined p-Value = 1
  • Tracking QA for Pythia D0-jet: build is SUCCESS, 📊 trends
    • 📊 QA-Intt : combined Chi2/nDoF = -0 / 72, and combined p-Value = 1
    • 📊 QA-Micromegas : combined Chi2/nDoF = -0 / 20, and combined p-Value = 1
    • 📊 QA-Mvtx : combined Chi2/nDoF = -0 / 54, and combined p-Value = 1
    • 📊 QA-Tpc : combined Chi2/nDoF = -0 / 56, and combined p-Value = 1
    • 📊 QA-tracking : combined Chi2/nDoF = -0 / 50, and combined p-Value = 1
    • 📊 QA-vertexing : combined Chi2/nDoF = 30 / 112, and combined p-Value = 1
  • Tracking QA from run2pp 53877: build is FAILURE, 📊 trends
  • system alma9.2-gcc-14.2.0, build new: run the default sPHENIX macro: build is SUCCESS, output, trends 📊
  • system alma9.2-gcc-14.2.0, build new: run the default CaloProduction/Fun4All_Year2.C macro: build is SUCCESS, output, trends 📊
  • system alma9.2-gcc-14.2.0, build new: run the default StreamingProduction/Fun4All_Stream_Combiner.C macro: build is SUCCESS, output, trends 📊
  • system alma9.2-gcc-14.2.0, build new: Valgrind test of CaloProduction/Fun4All_Year2.C: build is SUCCESS, 📊valgrind report, trends 📊
  • system alma9.2-gcc-14.2.0, build new: Valgrind test of StreamingProduction/Fun4All_Stream_Combiner.C: build is SUCCESS, 📊valgrind report, trends 📊
  • system alma9.2-gcc-14.2.0, build new: run the overlap check for sPHENIX macro: build is SUCCESS, output
  • system alma9.2-gcc-14.2.0, build new: Valgrind test: build is SUCCESS, 📊valgrind report, trends 📊
• Build with configuration of alma9.2-gcc-14.2.0 / scan is SUCCESS, 📊scan-build report (full)/(new), build log
• clang-tidy is SUCCESS, 📊clang-tidy report (full)/(new)
• cpp-check is SUCCESS, 📊cppcheck report (full)/(new)

---

Automatically generated by sPHENIX Jenkins continuous integration
           

[sphenix-jenkins-ci]

Build & test report

Report for commit 6946cba0986c7c4f5a458562a5aedc9cf5cf1380:

• builds and tests overall are FAILURE.
• Build with configuration of alma9.2-gcc-14.2.0 / clang is SUCCESS, 📊clang report (full)/(new), build log
• Build with configuration of alma9.2-gcc-14.2.0 / new is FAILURE, 📊Compiler report (full)/(new), build log
  • Generating DST and readback: build is SUCCESS
  • Calorimeter QA: build is SUCCESS, 📊 trends
    • 📊 QA-calorimeter for e- at p_T=4GeV : combined Chi2/nDoF = 27.45 / 72, and combined p-Value = 1
    • 📊 QA-calorimeter for pi+ at p_T=30GeV : combined Chi2/nDoF = 41.6183 / 72, and combined p-Value = 0.998442
    • 📊 QA-calorimetric-jet for e- at p_T=4GeV : combined Chi2/nDoF = 0.4559 / 42, and combined p-Value = 1
    • 📊 QA-calorimetric-jet for pi+ at p_T=30GeV : combined Chi2/nDoF = 14.2531 / 42, and combined p-Value = 0.999981
  • Tracking QA with Distortions: build is SUCCESS, 📊 trends
    • 📊 QA-distortions
  • Tracking QA at low occupancy: build is SUCCESS, 📊 trends
    • 📊 QA-Intt : combined Chi2/nDoF = -0 / 72, and combined p-Value = 1
    • 📊 QA-Micromegas : combined Chi2/nDoF = -0 / 20, and combined p-Value = 1
    • 📊 QA-Mvtx : combined Chi2/nDoF = -0 / 54, and combined p-Value = 1
    • 📊 QA-Tpc : combined Chi2/nDoF = 5.69615e-08 / 56, and combined p-Value = 1
    • 📊 QA-tracking : combined Chi2/nDoF = 0.00798791 / 56, and combined p-Value = 1
    • 📊 QA-vertexing : combined Chi2/nDoF = 40.6851 / 112, and combined p-Value = 1
  • Tracking QA for Pythia D0-jet: build is SUCCESS, 📊 trends
    • 📊 QA-Intt : combined Chi2/nDoF = -0 / 72, and combined p-Value = 1
    • 📊 QA-Micromegas : combined Chi2/nDoF = -0 / 20, and combined p-Value = 1
    • 📊 QA-Mvtx : combined Chi2/nDoF = -0 / 54, and combined p-Value = 1
    • 📊 QA-Tpc : combined Chi2/nDoF = -0 / 56, and combined p-Value = 1
    • 📊 QA-tracking : combined Chi2/nDoF = -0 / 50, and combined p-Value = 1
    • 📊 QA-vertexing : combined Chi2/nDoF = 30 / 112, and combined p-Value = 1
  • Tracking QA from run2pp 53877: build is FAILURE, 📊 trends
  • system alma9.2-gcc-14.2.0, build new: run the default sPHENIX macro: build is SUCCESS, output, trends 📊
  • system alma9.2-gcc-14.2.0, build new: run the default CaloProduction/Fun4All_Year2.C macro: build is SUCCESS, output, trends 📊
  • system alma9.2-gcc-14.2.0, build new: run the default StreamingProduction/Fun4All_Stream_Combiner.C macro: build is SUCCESS, output, trends 📊
  • system alma9.2-gcc-14.2.0, build new: Valgrind test of CaloProduction/Fun4All_Year2.C: build is SUCCESS, 📊valgrind report, trends 📊
  • system alma9.2-gcc-14.2.0, build new: Valgrind test of StreamingProduction/Fun4All_Stream_Combiner.C: build is SUCCESS, 📊valgrind report, trends 📊
  • system alma9.2-gcc-14.2.0, build new: run the overlap check for sPHENIX macro: build is SUCCESS, output
  • system alma9.2-gcc-14.2.0, build new: Valgrind test: build is SUCCESS, 📊valgrind report, trends 📊
• Build with configuration of alma9.2-gcc-14.2.0 / scan is SUCCESS, 📊scan-build report (full)/(new), build log
• clang-tidy is FAILURE, 📊clang-tidy report (full)/(new)
• cpp-check is SUCCESS, 📊cppcheck report (full)/(new)

---

Automatically generated by sPHENIX Jenkins continuous integration