Skip to content

docs: more readme and compressionlevel option - #424

Merged
APN-Pucky merged 5 commits into
mainfrom
more_docs
Sep 25, 2026
Merged

APN-Pucky merged 5 commits into
mainfrom
more_docs

Conversation

@APN-Pucky

Copy link
Copy Markdown
Member

Part-of: #409 (the edit of statement of need missing in the docs)

@codecov

codecov Bot commented Sep 25, 2026 •

Copy link
Copy Markdown

Codecov Report

✅ All modified and coverable lines are covered by tests.
✅ Project coverage is 100.00%. Comparing base (fbc3fdf) to head (0e94ff6).
⚠️ Report is 1 commits behind head on main.

Additional details and impacted files
@@            Coverage Diff            @@
##              main      #424   +/-   ##
=========================================
  Coverage   100.00%   100.00%           
=========================================
  Files            3         3           
  Lines          960       962    +2     
=========================================
+ Hits           960       962    +2     
Flag Coverage Δ
unittests-3.10 100.00% <100.00%> (ø)
unittests-3.11 100.00% <100.00%> (ø)
unittests-3.12 100.00% <100.00%> (ø)
unittests-3.13 100.00% <100.00%> (ø)
unittests-3.14 100.00% <100.00%> (ø)

Flags with carried forward coverage won't be shown. Click here to find out more.

☔ View full report in Codecov by Harness.
📢 Have feedback on the report? Share it here.

🚀 New features to boost your workflow:
  • ❄️ Test Analytics: Detect flaky tests, report on failures, and find test suite problems.

@github-actions

github-actions Bot commented Sep 25, 2026 •

Copy link
Copy Markdown

🏎️ Benchmark Comparison


---------------------------------------------------------------------------------------------------------- benchmark: 6 tests ----------------------------------------------------------------------------------------------------------
Name (time in ms)                                               Min                    Max                   Mean             StdDev                 Median                IQR            Outliers     OPS            Rounds  Iterations
----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------
test_count_events_benchmark (0002_mr)                      409.3224 (1.0)         416.2726 (1.00)        412.9724 (1.00)      2.3678 (1.58)        412.8384 (1.00)      3.9008 (1.91)          4;0  2.4215 (1.00)         10           1
test_count_events_benchmark (0001_base)                    411.0242 (1.00)        415.2406 (1.0)         412.6831 (1.0)       1.5006 (1.0)         412.3412 (1.0)       2.0458 (1.0)           3;0  2.4232 (1.0)          10           1
test_fromfile_and_to_awkward (0001_base)                 3,051.4207 (7.45)      3,071.5604 (7.40)      3,059.4226 (7.41)      5.9195 (3.94)      3,058.2005 (7.42)      5.1322 (2.51)          4;1  0.3269 (0.13)         10           1
test_fromfile_and_to_awkward (0002_mr)                   3,056.8912 (7.47)      3,096.2917 (7.46)      3,072.6583 (7.45)     11.4739 (7.65)      3,074.0235 (7.46)     16.1720 (7.91)          4;0  0.3255 (0.13)         10           1
test_write_random_events_gzip_benchmark (0001_base)     10,103.9989 (24.68)    10,204.6219 (24.58)    10,143.2711 (24.58)    31.2123 (20.80)    10,139.0520 (24.59)    49.3250 (24.11)         3;0  0.0986 (0.04)         10           1
test_write_random_events_gzip_benchmark (0002_mr)       10,132.5887 (24.75)    10,228.5702 (24.63)    10,176.2103 (24.66)    34.9565 (23.29)    10,165.8883 (24.65)    62.0141 (30.31)         5;0  0.0983 (0.04)         10           1
----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------

Legend:
  Outliers: 1 Standard Deviation from Mean; 1.5 IQR (InterQuartile Range) from 1st Quartile and 3rd Quartile.
  OPS: Operations Per Second, computed as 1 / Mean

@eduardo-rodrigues eduardo-rodrigues added the docs Documentation related label Sep 25, 2026
@APN-Pucky APN-Pucky changed the title more readme and compressionlevel option docs: more readme and compressionlevel option Sep 25, 2026
Comment thread src/pylhe/__init__.py Resolved
Co-authored-by: Eduardo Rodrigues <eduardo.rodrigues@cern.ch>
@APN-Pucky
APN-Pucky marked this pull request as ready for review September 25, 2026 09:57
Comment thread src/pylhe/__init__.py Resolved

Copilot AI left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

Copilot review overview

🟡 Changes recommended

Address the public dataclass field-order compatibility issue and add coverage for non-default compression levels.

Get a fresh assessment by requesting another Copilot review.

Review effort: Lite
Findings: 1 High severity · 1 Medium severity

Open (2)
What changed in this PR

Adds README rationale and configurable gzip compression levels for LHE XML output.

Changes:

  • Adds a “Why pylhe?” section to the README.
  • Adds compresslevel to LHEXMLFormat.
  • Clarifies HDF5 gzip compression settings.
File Summary
src/​pylhe/​__init__.py Critical: preserve positional dataclass compatibility. Moderate: add a regression test for non-default compression levels.
README.md Documents project rationale and supported capabilities.

💡 Add a code-review agent skill or configure MCP servers for context-aware, tailored reviews. Learn more in the docs.

Comment thread src/pylhe/__init__.py Resolved
Comment thread src/pylhe/__init__.py Resolved

@eduardo-rodrigues eduardo-rodrigues left a comment

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

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

Looks good, many thanks.

@APN-Pucky
APN-Pucky merged commit ea3ee7c into main Sep 25, 2026
18 checks passed
@APN-Pucky
APN-Pucky deleted the more_docs branch September 25, 2026 13:40
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

docs Documentation related

Projects

None yet

Development

Successfully merging this pull request may close these issues.

3 participants