minor #17803 [Workflow] Improve Workflow Documentation (lamasfoker)

javiereguiluz · javiereguiluz · commit 691b32a9417a · 2023-01-24T17:38:12.000+01:00
This PR was submitted for the 6.2 branch but it was squashed and merged into the 5.4 branch instead. Discussion ---------- [Workflow] Improve Workflow Documentation As you can see on the `MethodMarkingStore` [implementation](https://github.com/symfony/symfony/blob/v6.2.4/src/Symfony/Component/Workflow/MarkingStore/MethodMarkingStore.php#L64-L66), it checks if the `$marking` variable is `null` and not for empty `string` or empty `array`. So I suggest adding these changes to the Docu to declare it out of any doubt. I notice these also on the workflow demo by `@lyrixx`, specifically [here](https://github.com/lyrixx/SFLive-Paris2016-Workflow/blob/master/src/Entity/Article.php#L15-L16) and [here](https://github.com/lyrixx/SFLive-Paris2016-Workflow/blob/master/src/Entity/Task.php#L15-L16). Commits ------- 85ed54b [Workflow] Improve Workflow Documentation
diff --git a/workflow.rst b/workflow.rst
@@ -194,7 +194,10 @@ The configured property will be used via its implemented getter/setter methods b
     preferable to not configure it.
 
     A single state marking store uses a ``string`` to store the data. A multiple
-    state marking store uses an ``array`` to store the data.
+    state marking store uses an ``array`` to store the data. On both cases if no
+    state marking store is defined you have to return ``null``. So in the above
+    example should be defined a return type like ``App\Entity\BlogPost::getCurrentPlace(): ?array``
+    or like ``App\Entity\BlogPost::getCurrentPlace(): ?string``.
 
 .. tip::
 
