Repository navigation
Conversation
Document the parameters, return value, exceptions, and behavior of the two public functions that read L0 files. Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>
Member
Author
|
These docstrings were written by Claude. Nothing appeared to be glaringly wrong with them, but these will need careful review since I can neither confirm nor deny the veracity (truthiness?) of these docstrings. 👀 @joyvelasquez — could you read through these docstrings too, if you have the time? No worries if not. Stuff that we aren't able to confirm should go as a comment into the code rather than be included in a docstring, perhaps. 🤔 |
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.
Replaces the one-line docstrings of
read_fileandread_file_scinccsds_reader_pipeline.pywith full docstrings. These are the two public functions for reading L0 files into Python data structures.Each docstring now has
Parameters,Returns,Raises, andNotessections:read_filereads SPC instrument packets (APIDs 0x351–0x354, 0x35E, and 0x35F).read_file_screads spacecraft housekeeping packets. Its notes describe how the spacecraft housekeeping definition file is chosen: first from the MET of the first packet, then from a<year>/<day of year>part of the path, and finally by falling back to the newest definition file.RuntimeErrorwhen the file can't be opened or read, and write progress to standard output.The documentation builds with
--nitpicky --fail-on-warning.🤖 Generated with Claude Code