Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Add numpydoc Pre-Commit for Hit & Hi Pt.6 #651

Conversation

daralynnrhode
Copy link
Contributor

@daralynnrhode daralynnrhode commented Jun 19, 2024

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 and imap_processing/hi.

This PR will have changes made in imap_processing/hit and imap_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.

@daralynnrhode daralynnrhode changed the title [WIP] Add numpydoc Pre-Commit for Hit & Hi [WIP] Add numpydoc Pre-Commit for Hit & Hi Pt.6 Jun 19, 2024
@daralynnrhode daralynnrhode self-assigned this Jun 19, 2024
@daralynnrhode daralynnrhode added Repo: Documentation Improvements or additions to documentation Repo: Testing Related to testing labels Jun 19, 2024
@daralynnrhode daralynnrhode requested review from a team, bourque, sdhoyt, greglucas, subagonsouth, tech3371, vmartinez-cu and anamanica and removed request for a team June 19, 2024 16:53
@daralynnrhode daralynnrhode changed the title [WIP] Add numpydoc Pre-Commit for Hit & Hi Pt.6 Add numpydoc Pre-Commit for Hit & Hi Pt.6 Jun 19, 2024
@daralynnrhode daralynnrhode requested a review from a team June 19, 2024 18:12
Copy link
Contributor

@subagonsouth subagonsouth left a comment

Choose a reason for hiding this comment

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

Changes to Hi files look good to me. Thanks!

Copy link
Collaborator

@bourque bourque left a comment

Choose a reason for hiding this comment

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

LGTM!

@daralynnrhode daralynnrhode merged commit 19e48ba into IMAP-Science-Operations-Center:dev Jun 21, 2024
17 checks passed
@daralynnrhode daralynnrhode deleted the add_numpydoc_hit_hi branch June 21, 2024 21:50
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Repo: Documentation Improvements or additions to documentation Repo: Testing Related to testing
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants