Update action goal state diagram#226
Conversation
* Change transition labels to match text in design doc. * Renamed cancel_goal transition to request_cancel. This makes it more clear from the name that it is a *request* to cancel and not the actual canceling of a goal. Signed-off-by: Jacob Perron <jacob@openrobotics.org>
hidmic
left a comment
There was a problem hiding this comment.
LGTM! Bummer we can't keep cancel_goal, it was more consistent with send_goal.
We could keep it, although, IMO, "request_cancel" is more clear. |
|
I am not sure the "request" in the name is better. With any service your request is just that - a request - and the response could be "no, not going to do it". Therefore I think |
We should distinguish the cancel request event from the event where the goal is actually canceled (see ros2/rcl#399 (comment)). I think the events "cancel_goal" and "cancel" are more ambiguous than "request_cancel" and "cancel". In any case, it's probably not helping that we're conflating the user request to cancel and the goal state transition. |
From the wording "cancel" alone it is again not clear if that is just a request, it is about to happen or it is already done. I would argue that the natural language already has a clean way to distinguish these two cases:
|
request_cancel -> cancel_goal cancel -> canceled Signed-off-by: Jacob Perron <jacob@openrobotics.org>
|
I've reverted the change to the "cancel_goal" transition and renamed the "cancel" transition to "canceled" as per @dirk-thomas's suggestion. I've updated the state diagram accordingly. |
Typo: Should it not be |
It depends on which flavor of English you learned: https://www.grammarly.com/blog/canceled-vs-cancelled/ |
|
Though if I get really picky, I find the use of |
Could be changed to |
I'm somewhat inclined towards verbs, but yeah, that's the alternative. Anyways, it isn't super important. |
Using verbs to describe a status seems off to me. |
Agreed, but IIUC it's not the status or state but the event that we're describing here. |
Correct. These are the names of the transitions between states. I believe the word "canceled" can be used as an adjective and as a verb. |
This makes it more clear from the name that it is a request to cancel and not the actual canceling of a goal.
Related to changes happening for ros2/rcl#399.