Fix phpdocs #28714
Merged
Fix phpdocs #28714
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
chalasr
reviewed
Oct 4, 2018
| * @param string $name The argument name | ||
| * @param int|null $mode The argument mode: InputArgument::REQUIRED or InputArgument::OPTIONAL | ||
| * @param string $description A description text | ||
| * @param mixed $default The default value (for InputArgument::OPTIONAL mode only) |
There was a problem hiding this comment.
Params should be the same as InputArgument::__construct() which has been corrected recently
symfony/src/Symfony/Component/Console/Input/InputArgument.php
Lines 34 to 37 in 196086c
chalasr
reviewed
Oct 4, 2018
| * @param int $mode The option mode: One of the InputOption::VALUE_* constants | ||
| * @param string $description A description text | ||
| * @param mixed $default The default value (must be null for InputOption::VALUE_NONE) | ||
| * @param string $name The option name |
There was a problem hiding this comment.
Same but for InputOption
symfony/src/Symfony/Component/Console/Input/InputOption.php
Lines 36 to 40 in 196086c
|
@chalasr Fixed it. Docs are now equal to the docs from the object constructors (InputArgument/InputOption) |
chalasr
approved these changes
Oct 5, 2018
|
For 2.8 |
xabbuh
approved these changes
Oct 5, 2018
fabpot
approved these changes
Oct 6, 2018
See phan/phan#2025 for explaination
|
Thank you @mschop. |
fabpot
added a commit
that referenced
this pull request
Oct 6, 2018
This PR was submitted for the master branch but it was merged into the 2.8 branch instead (closes #28714). Discussion ---------- Fix phpdocs | Q | A | ------------- | --- | Branch? | all supported releases and master | Bug fix? | yes | New feature? | no | BC breaks? | no | Deprecations? | no | Tests pass? | yes (I didn't run them, but just changed docs) | Fixed tickets | None | License | MIT See phan/phan#2025 for details. Fix phpdocs for Command for preventing static code analysis tools to emit false positives. Commits ------- 7196e49 Fix phpdocs
chalasr
pushed a commit
that referenced
this pull request
Nov 14, 2018
This PR was merged into the 2.8 branch. Discussion ---------- Command::addOption should allow int in $default | Q | A | ------------- | --- | Branch? | all | Bug fix? | yes | New feature? | no | BC breaks? | no | Deprecations? | no | Tests pass? | yes | Fixed tickets | none | License | MIT | Doc PR | <!-- Write a short README entry for your feature/bugfix here (replace this comment block.) This will help people understand your PR and can be used as a start of the Doc PR. Additionally: - Bug fixes must be submitted against the lowest branch where they apply (lowest branches are regularly merged to upper ones so they get the fixes too). - Features and deprecations must be submitted against the master branch. --> In #28714 the documentation for `$default` on `Command::addOption` was changed to specify more specifically than `mixed`. However, there is an inconsistency as `InputOption::__construct` allows int in its `$default`, but not `Command::addOption`. This PR makes fixes that inconsistency. Commits ------- 5f8bd89 Command::addOption should allow int in $default
mhujer
added a commit
to mhujer/symfony
that referenced
this pull request
Dec 23, 2018
Issue was introduced symfony#28714
fabpot
added a commit
that referenced
this pull request
Dec 23, 2018
This PR was merged into the 3.4 branch. Discussion ---------- [Console] fix PHPDoc in Command | Q | A | ------------- | --- | Branch? | 3.4 up to 4.2 for bug fixes <!-- see below --> | Bug fix? | yes | New feature? | no <!-- don't forget to update src/**/CHANGELOG.md files --> | BC breaks? | no <!-- see https://symfony.com/bc --> | Deprecations? | no <!-- don't forget to update UPGRADE-*.md and src/**/CHANGELOG.md files --> | License | MIT <!-- Write a short README entry for your feature/bugfix here (replace this comment block.) This will help people understand your PR and can be used as a start of the Doc PR. Additionally: - Bug fixes must be submitted against the lowest branch where they apply (lowest branches are regularly merged to upper ones so they get the fixes too). - Features and deprecations must be submitted against the master branch. --> Issue was introduced in #28714, this PR fixes copy&paste from `InputArgument` and `InputOption`. Commits ------- 13bcd6a [Console] fix PHPDoc in Command
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.
See phan/phan#2025 for details.
Fix phpdocs for Command for preventing static code analysis tools to emit false positives.