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

Style code and document #522

Merged
merged 1 commit into from
Dec 14, 2023
Merged

Style code and document #522

merged 1 commit into from
Dec 14, 2023

Conversation

ChristineStawitz-NOAA
Copy link
Contributor

Auto-generated by doc-and-style-r.yml

Copy link
Contributor

Instructions for code reviewer

Hello reviewer, thanks for taking the time to review this PR!

  • Please use this checklist during your review, checking off items that you have verified are complete!
  • For PRs that don't make changes to code (e.g., changes to README.md or Github actions workflows), feel free to skip over items on the checklist that are not relevant. Remember it is still important to do a thorough review.
  • Then, comment on the pull request with your review indicating where you have questions or changes need to be made before merging.
  • Remember to review every line of code you’ve been asked to review, look at the context, make sure you’re improving code health, and compliment developers on good things that they do.
  • PR reviews are a great way to learn, so feel free to share your tips and tricks. However, for optional changes (i.e., not required for merging), please include nit: (for nitpicking) before making the suggestion. For example, nit: I prefer using a data.frame() instead of a matrix because...
  • Engage with the developer when they respond to comments and check off additional boxes as they become complete so the PR can be merged in when all the tasks are fulfilled. Make it clear when this has been reached by commenting on the PR with something like This PR is now ready to be merged, no changes needed.

Checklist

  • The PR is requested to be merged into the appropriate branch (typically main)
  • The code is well-designed.
  • The functionality is good for the users of the code.
  • Any User Interface changes are sensible and look good.
  • The code isn’t more complex than it needs to be.
  • Code coverage remains high, indicating the new code is tested.
  • The developer used clear names for everything.
  • Comments are clear and useful, and mostly explain why instead of what.
  • Code is appropriately documented (doxygen and roxygen).

Copy link

codecov bot commented Nov 14, 2023

Codecov Report

All modified and coverable lines are covered by tests ✅

Comparison is base (6a083f9) 76.88% compared to head (a3c4c6c) 75.40%.

❗ Current head a3c4c6c differs from pull request most recent head e0e606a. Consider uploading reports for the commit e0e606a to get more accurate results

Additional details and impacted files
@@            Coverage Diff             @@
##             main     #522      +/-   ##
==========================================
- Coverage   76.88%   75.40%   -1.48%     
==========================================
  Files          38       39       +1     
  Lines        1830     2090     +260     
  Branches        0      140     +140     
==========================================
+ Hits         1407     1576     +169     
- Misses        423      471      +48     
- Partials        0       43      +43     

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

@Andrea-Havron-NOAA Andrea-Havron-NOAA merged commit 1fdf86d into main Dec 14, 2023
11 checks passed
@Andrea-Havron-NOAA Andrea-Havron-NOAA deleted the style-doc-code branch December 14, 2023 17:42
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants