8000 fix some docblocks by xabbuh · Pull Request #11483 · symfony/symfony · GitHub
[go: up one dir, main page]

Skip to content

fix some docblocks #11483

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 1 commit into from
Aug 2, 2014
Merged

fix some docblocks #11483

merged 1 commit into from
Aug 2, 2014

Conversation

xabbuh
Copy link
Member
@xabbuh xabbuh commented Jul 26, 2014
Q A
Bug fix? yes
New feature? no
BC breaks? no
Deprecations? no
Tests pass? yes
Fixed tickets
License MIT
Doc PR

@@ -321,7 +321,7 @@ public function askHiddenResponse(OutputInterface $output, $question, $fallback
* @param OutputInterface $output An Output instance
* @param string|array $question The question to ask
* @param callable $validator A PHP callback
* @param int $attempts Max number of times to ask before giving up (false by default, which means infinite)
* @param int|bool $attempts Max number of times to ask before giving up (false by default, which means infinite)
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

true is not valid, so it should be int|false, but I'm not sure it is supported by the phpdoc "spec".

Copy link
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I thought it isn't. That's the reason I used bool instead.

Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

We are using xxx|false in quite a few places already, so that's what I would use here as well.

Copy link
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I see. Changed it here and in the other places as well.

@fabpot
Copy link
Member
fabpot commented Aug 2, 2014

Thank you @xabbuh.

@fabpot fabpot merged commit 1775da5 into symfony:2.3 Aug 2, 2014
fabpot added a commit that referenced this pull request Aug 2, 2014
This PR was merged into the 2.3 branch.

Discussion
----------

fix some docblocks

| Q             | A
| ------------- | ---
| Bug fix?      | yes
| New feature?  | no
| BC breaks?    | no
| Deprecations? | no
| Tests pass?   | yes
| Fixed tickets |
| License       | MIT
| Doc PR        |

Commits
-------

1775da5 fix some docblocks
@xabbuh xabbuh deleted the phpdoc-fixes branch August 2, 2014 08:24
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants
0