Skip to content

Commit 0af9572

Browse files
committed
minor #9210 Clarify the "enter(-ed)" events (thePanz, javiereguiluz)
This PR was submitted for the 3.3 branch but it was merged into the 3.4 branch instead (closes #9210). Discussion ---------- Clarify the "enter(-ed)" events Added clarification about the marker-store for the `enter` and `entered` events. Commits ------- f73660d Minor reword 92abab6 Clarify the "enter(-ed)" events
2 parents bfe85b8 + f73660d commit 0af9572

File tree

1 file changed

+8
-7
lines changed

1 file changed

+8
-7
lines changed

workflow/usage.rst

Lines changed: 8 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -203,7 +203,7 @@ order:
203203
* ``workflow.[workflow name].guard.[transition name]``
204204

205205
``workflow.leave``
206-
The object is about to leave a place.
206+
The subject is about to leave a place.
207207

208208
The three events being dispatched are:
209209

@@ -212,7 +212,7 @@ order:
212212
* ``workflow.[workflow name].leave.[place name]``
213213

214214
``workflow.transition``
215-
The object is going through this transition.
215+
The subject is going through this transition.
216216

217217
The three events being dispatched are:
218218

@@ -221,8 +221,9 @@ order:
221221
* ``workflow.[workflow name].transition.[transition name]``
222222

223223
``workflow.enter``
224-
The object entered a new place. This is the first event where the object
225-
is marked as being in the new place.
224+
The subject is about to enter a new place. This event is triggered just
225+
before the subject places are updated, which means that the marking of the
226+
subject is not yet updated with the new places.
226227

227228
The three events being dispatched are:
228229

@@ -231,8 +232,8 @@ order:
231232
* ``workflow.[workflow name].enter.[place name]``
232233

233234
``workflow.entered``
234-
Similar to ``workflow.enter``, except the marking store is updated before this
235-
event (making it a good place to flush data in Doctrine).
235+
The subject has entered in the places and the marking is updated (making it a good
236+
place to flush data in Doctrine).
236237

237238
The three events being dispatched are:
238239

@@ -251,7 +252,7 @@ order:
251252

252253

253254
``workflow.announce``
254-
Triggered for each transition that now is accessible for the object.
255+
Triggered for each transition that now is accessible for the subject.
255256

256257
The three events being dispatched are:
257258

0 commit comments

Comments
 (0)