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 #714

Merged
merged 1 commit into from
Jan 3, 2025
Merged

Style code and document #714

merged 1 commit into from
Jan 3, 2025

Conversation

ChristineStawitz-NOAA
Copy link
Contributor

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

Copy link
Contributor

github-actions bot commented Jan 3, 2025

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 Jan 3, 2025

Codecov Report

All modified and coverable lines are covered by tests ✅

Project coverage is 65.73%. Comparing base (2338d23) to head (5ce7eca).
Report is 1 commits behind head on main.

Additional details and impacted files
@@           Coverage Diff           @@
##             main     #714   +/-   ##
=======================================
  Coverage   65.73%   65.73%           
=======================================
  Files          16       16           
  Lines         715      715           
  Branches      197      197           
=======================================
  Hits          470      470           
  Misses        160      160           
  Partials       85       85           

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

@kellijohnson-NOAA kellijohnson-NOAA force-pushed the style-doc-code branch 2 times, most recently from ac2ca0b to 3d1806c Compare January 3, 2025 15:59
* styler is automatically creating four spaces for function argument indents
  when the tidyverse style guide only has 2 with the ) { on the next line.
  So, I went in and manually changed them all back.
* Removed the latex code from the maturity vignette because it was leading
  to a failed build on R universe.
* Fixed incorrect edit to call-calc_coverage with adding workflow_dispatch
  underneath a PR.
Copy link
Contributor

@kellijohnson-NOAA kellijohnson-NOAA left a comment

Choose a reason for hiding this comment

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

Removed the 4-space indent because that goes against the tidyverse guidelines. Also, ) { should be on its own line after function arguments when indenting by two spaces.

@kellijohnson-NOAA kellijohnson-NOAA merged commit cb222ec into main Jan 3, 2025
14 checks passed
@kellijohnson-NOAA kellijohnson-NOAA deleted the style-doc-code branch January 3, 2025 16:31
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