refactor: rename checkFleeStopAction -> checkFleeContinueAction #104
Conversation
irritating implementation in critter behaviour
Jacob-Rueckert
added
the
Type: Refactoring
There was a problem hiding this comment.
The code change itself is good, I'm just being a bit picky about PR description and required follow-ups before we get this merged 🙃
Regarding the PR description:
irritating implementation in critter behaviour
You'll usually start off with noting what you changed, and why. The sentence above covers the first layer of why, but poses more questions for your reviewers: What was irritating about the name? Why was it misleading?
The second thing is that this action is (potentially) used in other modules. I can see two ways to address this here:
- a) add a note to the PR that this is an incompatible or breaking change, and that consuming modules will have to adjust their reference for this rename
- b) directly make the required changes in other modules, commit them to respective PRs, and then link back to this PR.
We already discussed that we want to go for option b. To reference another PR, you can just post the link (https://github.com/Terasology/Behaviors/pull/104) in the issue description, and GitHub will automatically create a back reference. It will also render it nicely, like #104.
body: changing depending function names from previous commit
CheckFleeStopAction was used Twice in wildanimals
with original Function now called CheckFleeContinueAction it needed a change
footer: mentioned commit is Terasology/Behaviors#104
Changed the name of the Function
The Function name was irritating due to it giving a True for a Return.
While the Value was used to Continue the Function.
Therefore having the Function named CheckFleeStopAction was irritating and i changed it to CheckFleeContinueAction