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

renamed dimension folded indices to be clearer #480

Merged
merged 1 commit into from
Oct 24, 2023
Merged

Conversation

peterkuriyama-NOAA
Copy link
Collaborator

@peterkuriyama-NOAA peterkuriyama-NOAA commented Oct 18, 2023

Co-authored-by: Kathryn Doering kathryn.doering@noaa.gov
Co-authored-by: Meg Oshima MOshima-PIFSC@users.noreply.github.com
Co-authored-by: Chris Legault chris.legault@noaa.gov

What is the feature?

  • Rename dimension folded indices to be clearer

How have you implemented the solution?

Replaced index_ya and index_ya2 to be i_age_year and i_agem1_yearm1

Does the PR impact any other area of the project?

No anticipated changes to input and output

How to test this change

Not applicable, checked with github actions

Developer pre-PR checklist

  • I relied on GitHub actions to 🧪 things for me while I sat on the 🛋️.

@github-actions
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).

@codecov
Copy link

codecov bot commented Oct 18, 2023

Codecov Report

All modified and coverable lines are covered by tests ✅

Files Coverage Δ
.../include/interface/rcpp/rcpp_objects/rcpp_data.hpp 95.74% <100.00%> (ø)
inst/include/population_dynamics/fleet/fleet.hpp 96.20% <100.00%> (-0.10%) ⬇️
...lude/population_dynamics/population/population.hpp 100.00% <100.00%> (ø)

... and 11 files with indirect coverage changes

📢 Thoughts on this report? Let us know!.

Co-authored-by: Kathryn Doering <kathryn.doering@noaa.gov>
Co-authored-by: Meg Oshima <MOshima-PIFSC@users.noreply.github.com>
Co-authored-by: Chris Legault <chris.legault@noaa.gov>
@github-actions
Copy link
Contributor

github-actions bot commented Oct 24, 2023

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
Contributor

@iantaylor-NOAA iantaylor-NOAA left a comment

Choose a reason for hiding this comment

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

Change are straightforward and improve clarity. I like the improved naming convention.

@Andrea-Havron-NOAA Andrea-Havron-NOAA merged commit 44c4716 into main Oct 24, 2023
14 checks passed
@Andrea-Havron-NOAA Andrea-Havron-NOAA deleted the issue272 branch October 24, 2023 18:20
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.

[Refactor]: rename dimension folded indices to be clearer
3 participants