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

411 refactor naming convention of member and local variables in the fleet class #476

Conversation

Bai-Li-NOAA
Copy link
Contributor

What is the feature?

Refactor member names in the fleet class

How have you implemented the solution?

  • Use "_m" as a postfix for members of a class
  • Use "fleet_" as a prefix for members from fleet class
  • Use "interface_" as a prefix for members from interface class

Does the PR impact any other area of the project?

How to test this change

Passed GHA workflows can be found here

Developer pre-PR checklist

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

@Bai-Li-NOAA Bai-Li-NOAA linked an issue Oct 10, 2023 that may be closed by this pull request
1 task
@github-actions
Copy link
Contributor

github-actions bot commented Oct 10, 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).

@codecov-commenter
Copy link

codecov-commenter commented Oct 10, 2023

Codecov Report

Attention: 2 lines in your changes are missing coverage. Please review.

Files Coverage Δ
...include/interface/rcpp/rcpp_objects/rcpp_fleet.hpp 92.45% <100.00%> (ø)
inst/include/population_dynamics/fleet/fleet.hpp 96.20% <ø> (-0.10%) ⬇️
inst/include/common/information.hpp 67.52% <88.23%> (ø)

... and 12 files with indirect coverage changes

📢 Thoughts on this report? Let us know!.

@Bai-Li-NOAA Bai-Li-NOAA requested review from a team and k-doering-NOAA and removed request for a team October 10, 2023 16:50
inst/include/common/information.hpp Outdated Show resolved Hide resolved
inst/include/common/information.hpp Outdated Show resolved Hide resolved
@ChristineStawitz-NOAA
Copy link
Contributor

We should add documentation somewhere in the code, and also in the collaborative workflow doc, of the use of _m so it's clear to users and developers why we are using the notation.

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

Bai-Li-NOAA and others added 6 commits October 20, 2023 15:53
Co-authored-by: KyleShertzer-NOAA <KyleShertzer-NOAA@users.noreply.github.com>
Co-authored-by: Jim Ianelli <jim.ianelli@gmail.com>
Co-authored-by: Ian Taylor <iantaylor-NOAA@users.noreply.github.com>
Co-authored-by: Andrea-Havron-NOAA <Andrea-Havron-NOAA@users.noreply.github.com>
@Bai-Li-NOAA Bai-Li-NOAA force-pushed the 411-refactor-revisit-naming-convention-of-member-and-local-variables-in-a-class branch from a1d9a5d to a9666e0 Compare October 20, 2023 19:53
@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).

@Bai-Li-NOAA
Copy link
Contributor Author

@ChristineStawitz-NOAA Documentation has been added in the code and an issue has been submitted to the collaborative workflow repo.

@ChristineStawitz-NOAA ChristineStawitz-NOAA merged commit 61d1ddb into main Oct 23, 2023
14 checks passed
@ChristineStawitz-NOAA ChristineStawitz-NOAA deleted the 411-refactor-revisit-naming-convention-of-member-and-local-variables-in-a-class branch October 23, 2023 16:30
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]: Revisit naming convention of member and local variables in a class
4 participants