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

PUNCH user guide #316

Merged
merged 17 commits into from
Nov 25, 2024
Merged

PUNCH user guide #316

merged 17 commits into from
Nov 25, 2024

Conversation

lowderchris
Copy link
Contributor

@lowderchris lowderchris commented Nov 19, 2024

PR summary

Updates and adds user guide details.

Overall todos

  • data product guide
  • level 1 documentation
  • level 2 documentation
  • level 3 documentation
  • quickPUNCH documentation
  • update of NDCube references

Related Issues / todos

This update will also resolve #314 , resolve #282 , and resolve #186

@lowderchris lowderchris added the documentation Improvements or additions to documentation label Nov 19, 2024
@lowderchris lowderchris self-assigned this Nov 19, 2024
Copy link

codecov bot commented Nov 19, 2024

Codecov Report

All modified and coverable lines are covered by tests ✅

Project coverage is 86.97%. Comparing base (79c49dc) to head (14169e8).
Report is 114 commits behind head on main.

Additional details and impacted files
@@            Coverage Diff             @@
##             main     #316      +/-   ##
==========================================
- Coverage   88.31%   86.97%   -1.34%     
==========================================
  Files          56       56              
  Lines        3740     3717      -23     
==========================================
- Hits         3303     3233      -70     
- Misses        437      484      +47     

☔ View full report in Codecov by Sentry.
📢 Have feedback on the report? Share it here.

@lowderchris lowderchris marked this pull request as ready for review November 22, 2024 21:21
Copy link
Member

@jmbhughes jmbhughes left a comment

Choose a reason for hiding this comment

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

Great work! just a few comments we should work through.

@jmbhughes
Copy link
Member

pre-commit.ci autofix

@lowderchris lowderchris merged commit 2561669 into main Nov 25, 2024
7 of 8 checks passed
@lowderchris lowderchris deleted the user-guide branch November 25, 2024 20:05
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment