minor #13226 [Workflow] Document the optional message of setBlocked() (javiereguiluz)

javiereguiluz · javiereguiluz · commit f71374244dbd · 2020-02-23T11:21:14.000+01:00
This PR was merged into the master branch. Discussion ---------- [Workflow] Document the optional message of setBlocked() Fixes #12686. Commits ------- 15bb0f7 [Workflow] Document the optional message of setBlocked()
diff --git a/workflow.rst b/workflow.rst
@@ -423,8 +423,7 @@ missing a title::
             $title = $post->title;
 
             if (empty($title)) {
-                // Block the transition "to_review" if the post has no title
-                $event->setBlocked(true);
+                $event->setBlocked(true, 'This blog post cannot be marked as reviewed because it has no title.');
             }
         }
 
@@ -436,6 +435,10 @@ missing a title::
         }
     }
 
+.. versionadded:: 5.1
+
+    The optional second argument of ``setBlocked()`` was introduced in Symfony 5.1.
+
 Event Methods
 ~~~~~~~~~~~~~
 

Original file line number	Diff line number	Diff line change
`@@ -423,8 +423,7 @@ missing a title::`
`423`	`423`	`$title = $post->title;`
`424`	`424`
`425`	`425`	`if (empty($title)) {`
`426`		`- // Block the transition "to_review" if the post has no title`
`427`		`- $event->setBlocked(true);`
	`426`	`+ $event->setBlocked(true, 'This blog post cannot be marked as reviewed because it has no title.');`
`428`	`427`	`}`
`429`	`428`	`}`
`430`	`429`
`@@ -436,6 +435,10 @@ missing a title::`
`436`	`435`	`}`
`437`	`436`	`}`
`438`	`437`
	`438`	`+.. versionadded:: 5.1`
	`439`	`+`
	`440`	+ The optional second argument of ``setBlocked()`` was introduced in Symfony 5.1.
	`441`	`+`
`439`	`442`	`Event Methods`
`440`	`443`	`~~~~~~~~~~~~~`
`441`	`444`