Add numpydoc Pre-Commit for Hit & Hi Pt.6 #651
Merged
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.
Add numpydoc Pre-Commit Hook for files contained within hit and hi instrument folder.
Overview
Adding numpydoc pre-commit. Will be doing this in parts to make it more manageable. Making any needed changes flagged by the new pre-commit ONLY in files listed within
imap_processing/hit
andimap_processing/hi
.This PR will have changes made in
imap_processing/hit
andimap_processing/hi
.The folders and files listed above should be the only ones that numpydoc pre-commit checks will be run on.
For the most part, almost all the docstrings contained in the given files had to be updated. Most were small changes, others I had to fill in details based on what I could discern.
The main portions that need checked--and most are marked with TODO Double Check or something similar beside them-- are the Parameters and Returns sections. These are the sections I had to do the most additions in.
New Dependencies
New Files
Deleted Files
Updated Files
-pyproject.toml
-.pre-commit-config.yaml
Hit files
-imap_processing/hit/l1b/hit_l1b.py
-imap_processing/hit/l1a/hit_l1a.py
-imap_processing/hit/l0/utils/hit_base.py
-imap_processing/hit/l0/data_classes/science_packet.py
-imap_processing/hit/l0/data_classes/housekeeping.py
Hi files
-imap_processing/hi/utils.py
-imap_processing/hi/l1c/hi_l1c.py
-imap_processing/hi/l1b/hi_l1b.py
-imap_processing/hi/l1a/science_direct_event.py
-imap_processing/hi/l1a/housekeeping.py
-imap_processing/hi/l1a/histogram.py
-imap_processing/hi/l1a/hi_l1a.py
-imap_processing/hi/l0/decom_hi.py
Testing
-Added numpydoc pre-commits to .pre-commit-config.yaml and pyproject.toml. For now, .pre-commit-config.yaml has exclusions included in it that will be periodically removed as progressed is made in updating all files.