[Console] do not make the getHelp() method smart #15976
Merged
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
a0d204e to
169fad1
Compare
| @@ -513,7 +513,7 @@ public function getProcessedHelp() | |||
| $_SERVER['PHP_SELF'].' '.$name, | |||
| ); | |||
|
|
|||
| return str_replace($placeholders, $replacements, $this->getHelp()); | |||
| return str_replace($placeholders, $replacements, $this->getHelp() ? $this->getHelp() : $this->getDescription()); | |||
|
you should add a test covering the fallback for getProcessedHelp though |
169fad1 to
cdf1f00
Compare
|
added a test |
|
Thank you @xabbuh. |
fabpot
added a commit
that referenced
this pull request
Sep 28, 2015
This PR was merged into the 2.3 branch. Discussion ---------- [Console] do not make the getHelp() method smart | Q | A | ------------- | --- | Bug fix? | kind of | New feature? | no | BC breaks? | no | Deprecations? | no | Tests pass? | yes | Fixed tickets | | License | MIT | Doc PR | In my opinion, the way to always display a help message to the user was implemented in #15601 is not good enough. The getter method for the help should only return the actual value. Otherwise, user's would not have a way to check if a command really has a help message (for example, when building their own CLI applications or whatever). Instead, we should only return the description as a fallback of the help message when it is processed to present it to the user. Commits ------- cdf1f00 [Console] do not make the getHelp() method smart
This was referenced Oct 27, 2015
Closed
Merged
Merged
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
In my opinion, the way to always display a help message to the user was implemented in #15601 is not good enough. The getter method for the help should only return the actual value. Otherwise, user's would not have a way to check if a command really has a help message (for example, when building their own CLI applications or whatever). Instead, we should only return the description as a fallback of the help message when it is processed to present it to the user.