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

doc: remove notes containing syntax errors #658

Merged
merged 1 commit into from
Jul 26, 2024

Conversation

Bai-Li-NOAA
Copy link
Contributor

@Bai-Li-NOAA Bai-Li-NOAA commented Jul 26, 2024

What is the feature?

  • This PR fixes the issue causing the doc and style GHA (see log here)to fail on the main branch.

How have you implemented the solution?

  • Removed the notes section in the test that contained syntax errors.

Does the PR impact any other area of the project, maybe another repo?

  • No

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 Jul 26, 2024

Codecov Report

All modified and coverable lines are covered by tests ✅

Project coverage is 78.78%. Comparing base (081972c) to head (c356695).

Additional details and impacted files
@@           Coverage Diff           @@
##             main     #658   +/-   ##
=======================================
  Coverage   78.78%   78.78%           
=======================================
  Files          36       36           
  Lines        1975     1975           
  Branches      141      141           
=======================================
  Hits         1556     1556           
  Misses        376      376           
  Partials       43       43           

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

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.

Looks good. Merge in when you see fit @Bai-Li-NOAA

@Bai-Li-NOAA Bai-Li-NOAA merged commit 8b5ba1c into main Jul 26, 2024
15 checks passed
@Bai-Li-NOAA Bai-Li-NOAA deleted the test-make-r-tests-more-modular branch July 26, 2024 19:41
This pull request was closed.
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.

3 participants