minor #12703 [WIP][Console] Fix missing return in console documentation on execute function (JeremieSamson)

javiereguiluz · javiereguiluz · commit 1c22d72921b2 · 2019-12-09T15:30:58.000+01:00
This PR was submitted for the 5.0 branch but it was merged into the 4.4 branch instead (closes #12703). Discussion ---------- [WIP][Console] Fix missing return in console documentation on execute function Since Symfony 5.0, we have an error if we don't return an int on the `execute` function, I added it in the doc so there will not be an `TypeError` when trying this.  Commits ------- e2d1c06 Update console.rst
diff --git a/console.rst b/console.rst
@@ -146,6 +146,8 @@ the console::
         // outputs a message without adding a "\n" at the end of the line
         $output->write('You are about to ');
         $output->write('create a user.');
+        
+        return 0;
     }
 
 Now, try executing the command:
@@ -195,6 +197,8 @@ which returns an instance of
             // (this example deletes the last two lines of the section)
             $section1->clear(2);
             // Output is now completely empty!
+            
+            return 0;
         }
     }
 
@@ -235,6 +239,8 @@ Use input options or arguments to pass information to the command::
 
         // retrieve the argument value using getArgument()
         $output->writeln('Username: '.$input->getArgument('username'));
+        
+        return 0;
     }
 
 Now, you can pass the username to the command:
@@ -284,6 +290,8 @@ as a service, you can use normal dependency injection. Imagine you have a
             $this->userManager->create($input->getArgument('username'));
 
             $output->writeln('User successfully generated!');
+            
+            return 0;
         }
     }
 

Original file line number	Diff line number	Diff line change
`@@ -146,6 +146,8 @@ the console::`
`146`	`146`	`// outputs a message without adding a "\n" at the end of the line`
`147`	`147`	`$output->write('You are about to ');`
`148`	`148`	`$output->write('create a user.');`
	`149`	`+`
	`150`	`+ return 0;`
`149`	`151`	`}`
`150`	`152`
`151`	`153`	`Now, try executing the command:`
`@@ -195,6 +197,8 @@ which returns an instance of`
`195`	`197`	`// (this example deletes the last two lines of the section)`
`196`	`198`	`$section1->clear(2);`
`197`	`199`	`// Output is now completely empty!`
	`200`	`+`
	`201`	`+ return 0;`
`198`	`202`	`}`
`199`	`203`	`}`
`200`	`204`
`@@ -235,6 +239,8 @@ Use input options or arguments to pass information to the command::`
`235`	`239`
`236`	`240`	`// retrieve the argument value using getArgument()`
`237`	`241`	`$output->writeln('Username: '.$input->getArgument('username'));`
	`242`	`+`
	`243`	`+ return 0;`
`238`	`244`	`}`
`239`	`245`
`240`	`246`	`Now, you can pass the username to the command:`
`@@ -284,6 +290,8 @@ as a service, you can use normal dependency injection. Imagine you have a`
`284`	`290`	`$this->userManager->create($input->getArgument('username'));`
`285`	`291`
`286`	`292`	`$output->writeln('User successfully generated!');`
	`293`	`+`
	`294`	`+ return 0;`
`287`	`295`	`}`
`288`	`296`	`}`
`289`	`297`