Add Args/Returns sections to calibration API docstrings - #548
Open
xuanku-001 wants to merge 3 commits into
Open
xuanku-001 wants to merge 3 commits into
xuanku-001 wants to merge 3 commits into
Conversation
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
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.
Summary
Adds
Args/Returns/Raisessections to the docstrings of the publiccalibration API, following the style already used elsewhere in the codebase
(e.g.
components/dld.py,components/pulses.py,components/xgm.py).calibration/calcat.py:setup_client,set_default_caldb_root, and thefive
CalCatAPIClientmethods (format_time,request,get,get_paged,post)calibration/constants.py:SingleConstant.ndarray,CalibrationData.require_calibrations,CalibrationData.select_calibrationscalibration/detector.py:DetectorData.list_by_instrumentAll existing sentences are preserved verbatim; only sections are added, so no
behaviour or signatures change. These docstrings are rendered on the
documentation site via mkdocstrings, where parameters, return values and
raised errors are currently not described.
I deliberately left the
select_trains/split_trainsmethods and theconstant metadata helpers untouched: their docstrings refer to the upstream
extra_datadocumentation on purpose, and adding parameter sections therewould just duplicate it.
Testing
python -m py_compilepasses on all touched filesadded)
This contribution was prepared with AI assistance (a local LLM-based agent harness with deterministic checks and human review).