Update docs for file_type of SimpleAnalysis or HS3#284
Conversation
* Also clarify that analyses should be attached to Submission not Table.
There was a problem hiding this comment.
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_typeparameter 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 Report✅ All modified and coverable lines are covered by tests. 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
Flags with carried forward coverage won't be shown. Click here to find out more. ☔ View full report in Codecov by Sentry. 🚀 New features to boost your workflow:
|
clelange
left a comment
There was a problem hiding this comment.
Looks good to me. I've made sure that the newly added links are working as well.
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"orfile_type="SimpleAnalysis"as arguments tosub.add_additional_resource. It also clarifies that analyses should be attached toSubmissionobjects notTableobjects. Since changes are only to the docs (and a minor update to a docstring) we don't need a new release ofhepdata_libimmediately.📚 Documentation preview 📚: https://hepdata-lib--284.org.readthedocs.build/en/284/