Skip to content

Update docs for file_type of SimpleAnalysis or HS3#284

Merged
clelange merged 1 commit into
mainfrom
simpleanalysis-hs3
Oct 21, 2025
Merged

Update docs for file_type of SimpleAnalysis or HS3#284
clelange merged 1 commit into
mainfrom
simpleanalysis-hs3

Conversation

@GraemeWatt
Copy link
Copy Markdown
Member

@GraemeWatt GraemeWatt commented Oct 21, 2025

We recently added highlighting of HS3 and SimpleAnalysis resource files in a similar way to HistFactory. See HEPData/hepdata#925 and HEPData/hepdata-submission#16. This PR adds examples of using file_type="HS3" or file_type="SimpleAnalysis" as arguments to sub.add_additional_resource. It also clarifies that analyses should be attached to Submission objects not Table objects. Since changes are only to the docs (and a minor update to a docstring) we don't need a new release of hepdata_lib immediately.


📚 Documentation preview 📚: https://hepdata-lib--284.org.readthedocs.build/en/284/

* Also clarify that analyses should be attached to Submission not Table.
Copy link
Copy Markdown

Copilot AI left a comment

Choose a reason for hiding this comment

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

Pull Request Overview

This PR updates documentation and a docstring to reflect newly added support for HS3 and SimpleAnalysis resource file types, which can now be highlighted on HEPData alongside the existing HistFactory support.

Key Changes

  • Updated the file_type parameter documentation to include "HS3" and "SimpleAnalysis" options
  • Added usage examples for the new file types in the documentation
  • Clarified that analysis resources should be attached to Submission objects rather than Table objects

Reviewed Changes

Copilot reviewed 2 out of 2 changed files in this pull request and generated no comments.

File Description
hepdata_lib/init.py Updated docstring to document new "HS3" and "SimpleAnalysis" file type options
docs/usage.rst Added usage examples for new file types, documentation references, and clarification about attaching analyses to Submission objects

Tip: Customize your code reviews with copilot-instructions.md. Create the file or learn how to get started.

@codecov
Copy link
Copy Markdown

codecov Bot commented Oct 21, 2025

Codecov Report

✅ All modified and coverable lines are covered by tests.
✅ Project coverage is 92.21%. Comparing base (96aab5e) to head (1efd5aa).
⚠️ Report is 4 commits behind head on main.

Additional details and impacted files
@@           Coverage Diff           @@
##             main     #284   +/-   ##
=======================================
  Coverage   92.21%   92.21%           
=======================================
  Files           5        5           
  Lines        1118     1118           
  Branches      237      237           
=======================================
  Hits         1031     1031           
  Misses         60       60           
  Partials       27       27           
Flag Coverage Δ
unittests-3.10 90.59% <ø> (ø)
unittests-3.11 90.59% <ø> (ø)
unittests-3.12 90.59% <ø> (ø)
unittests-3.13 90.59% <ø> (ø)
unittests-3.6 90.15% <ø> (ø)
unittests-3.7 90.15% <ø> (ø)
unittests-3.8 91.94% <ø> (ø)
unittests-3.9 90.33% <ø> (ø)

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

☔ View full report in Codecov by Sentry.
📢 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.

Copy link
Copy Markdown
Collaborator

@clelange clelange left a comment

Choose a reason for hiding this comment

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

Looks good to me. I've made sure that the newly added links are working as well.

@github-project-automation github-project-automation Bot moved this from To do to In Progress in @HEPData Oct 21, 2025
@clelange clelange merged commit b6ff6bb into main Oct 21, 2025
39 checks passed
@github-project-automation github-project-automation Bot moved this from In Progress to Done in @HEPData Oct 21, 2025
@clelange clelange deleted the simpleanalysis-hs3 branch October 21, 2025 13:00
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

Status: Done

Development

Successfully merging this pull request may close these issues.

3 participants