From 815edcc3bf6b514f9f3aafbae600e3a0cdbd4713 Mon Sep 17 00:00:00 2001 From: Emanuele Panzeri Date: Tue, 20 Feb 2018 18:40:59 +0100 Subject: [PATCH 1/2] Clarify the "enter(-ed)" events --- workflow/usage.rst | 15 ++++++++------- 1 file changed, 8 insertions(+), 7 deletions(-) diff --git a/workflow/usage.rst b/workflow/usage.rst index 9396e3b95d1..4d3ae611c28 100644 --- a/workflow/usage.rst +++ b/workflow/usage.rst @@ -203,7 +203,7 @@ order: * ``workflow.[workflow name].guard.[transition name]`` ``workflow.leave`` - The object is about to leave a place. + The subject is about to leave a place. The three events being dispatched are: @@ -212,7 +212,7 @@ order: * ``workflow.[workflow name].leave.[place name]`` ``workflow.transition`` - The object is going through this transition. + The subject is going through this transition. The three events being dispatched are: @@ -221,8 +221,9 @@ order: * ``workflow.[workflow name].transition.[transition name]`` ``workflow.enter`` - The object entered a new place. This is the first event where the object - is marked as being in the new place. + The subject is about to enter a new place. This is the event triggered before the + subject is going to be updated as being in the new places. + Please notice: the marking of the subject is not yet updated with the new places. The three events being dispatched are: @@ -231,8 +232,8 @@ order: * ``workflow.[workflow name].enter.[place name]`` ``workflow.entered`` - Similar to ``workflow.enter``, except the marking store is updated before this - event (making it a good place to flush data in Doctrine). + The subject has entered in the places and the marking is updated (making it a good + place to flush data in Doctrine). The three events being dispatched are: @@ -241,7 +242,7 @@ order: * ``workflow.[workflow name].entered.[place name]`` ``workflow.announce`` - Triggered for each transition that now is accessible for the object. + Triggered for each transition that now is accessible for the subject. The three events being dispatched are: From b16681b9cadb74e7927fc892c37dd00aaf54f230 Mon Sep 17 00:00:00 2001 From: Javier Eguiluz Date: Fri, 23 Feb 2018 09:14:55 +0100 Subject: [PATCH 2/2] Minor reword --- workflow/usage.rst | 6 +++--- 1 file changed, 3 insertions(+), 3 deletions(-) diff --git a/workflow/usage.rst b/workflow/usage.rst index 4d3ae611c28..397c0395c37 100644 --- a/workflow/usage.rst +++ b/workflow/usage.rst @@ -221,9 +221,9 @@ order: * ``workflow.[workflow name].transition.[transition name]`` ``workflow.enter`` - The subject is about to enter a new place. This is the event triggered before the - subject is going to be updated as being in the new places. - Please notice: the marking of the subject is not yet updated with the new places. + The subject is about to enter a new place. This event is triggered just + before the subject places are updated, which means that the marking of the + subject is not yet updated with the new places. The three events being dispatched are: