bug #44467 [Console] Fix parameter types for ProcessHelper::mustRun() (derrabus)

fabpot · fabpot · commit 53a45b28cfab · 2021-12-05T17:56:00.000+01:00
This PR was merged into the 4.4 branch. Discussion ---------- [Console] Fix parameter types for `ProcessHelper::mustRun()` | Q | A | ------------- | --- | Branch? | 4.4 | Bug fix? | yes | New feature? | no | Deprecations? | no | Tickets | N/A | License | MIT | Doc PR | N/A The `mustRun()` method wraps the `run()` method and therefor must accepts the same parameter types. However, `mustRun()` claims to accept a string as `$cmd` while `run()` requires it to be an array. This PR fixes the incorrect doc block. Commits ------- c1c8c20 Fix parameter types for ProcessHelper::mustRun()
diff --git a/src/Symfony/Component/Console/Helper/ProcessHelper.php b/src/Symfony/Component/Console/Helper/ProcessHelper.php
@@ -95,10 +95,10 @@ public function run(OutputInterface $output, $cmd, $error = null, callable $call
      * This is identical to run() except that an exception is thrown if the process
      * exits with a non-zero exit code.
      *
-     * @param string|Process $cmd      An instance of Process or a command to run
-     * @param string|null    $error    An error message that must be displayed if something went wrong
-     * @param callable|null  $callback A PHP callback to run whenever there is some
-     *                                 output available on STDOUT or STDERR
+     * @param array|Process $cmd      An instance of Process or a command to run
+     * @param string|null   $error    An error message that must be displayed if something went wrong
+     * @param callable|null $callback A PHP callback to run whenever there is some
+     *                                output available on STDOUT or STDERR
      *
      * @return Process The process that ran
      *

Original file line number	Diff line number	Diff line change
`@@ -95,10 +95,10 @@ public function run(OutputInterface $output, $cmd, $error = null, callable $call`
`95`	`95`	`* This is identical to run() except that an exception is thrown if the process`
`96`	`96`	`* exits with a non-zero exit code.`
`97`	`97`	`*`
`98`		`- * @param string\|Process $cmd An instance of Process or a command to run`
`99`		`- * @param string\|null $error An error message that must be displayed if something went wrong`
`100`		`- * @param callable\|null $callback A PHP callback to run whenever there is some`
`101`		`- * output available on STDOUT or STDERR`
	`98`	`+ * @param array\|Process $cmd An instance of Process or a command to run`
	`99`	`+ * @param string\|null $error An error message that must be displayed if something went wrong`
	`100`	`+ * @param callable\|null $callback A PHP callback to run whenever there is some`
	`101`	`+ * output available on STDOUT or STDERR`
`102`	`102`	`*`
`103`	`103`	`* @return Process The process that ran`
`104`	`104`	`*`