8000 [Console] Fix docblock of DescriptorInterface::describe by codedmonkey · Pull Request #26604 · symfony/symfony · GitHub
[go: up one dir, main page]

Skip to content

[Console] Fix docblock of DescriptorInterface::describe #26604

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
Mar 19, 2018

Conversation

codedmonkey
Copy link
Contributor
@codedmonkey codedmonkey commented Mar 19, 2018
Q A
Branch? 2.7
Bug fix? yes?

This might be the smallest commit ever, but I came across this docblock which seems to be incorrectly copied from

* Describes an InputArgument instance.
and it threw me off guard for a moment when I read it.

I can see more improvements being made (like mentioning the InvalidArgumentException) but I didn't want to overdo it.

@nicolas-grekas
Copy link
Member

@codedmonkey for your next PR, please keep the full PR template.

@fabpot
Copy link
Member
fabpot commented Mar 19, 2018

Thank you @codedmonkey.

@fabpot fabpot merged commit dad27b0 into symfony:2.7 Mar 19, 2018
fabpot added a commit that referenced this pull request Mar 19, 2018
…(codedmonkey)

This PR was merged into the 2.7 branch.

Discussion
----------

[Console] Fix docblock of DescriptorInterface::describe

| Q             | A
| ------------- | ---
| Branch?       | 2.7
| Bug fix?      | yes?

This might be the smallest commit ever, but I came across this docblock which seems to be incorrectly copied from https://github.com/symfony/symfony/blob/7101893b51cf6d6e2a9bc131eadefa0a02151d11/src/Symfony/Component/Console/Descriptor/Descriptor.php#L74 and it threw me off guard for a moment when I read it.

I can see more improvements being made (like mentioning the `InvalidArgumentException`) but I didn't want to overdo it.

Commits
-------

dad27b0 [Console] Fix docblock of DescriptorInterface::describe
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

Successfully merging this pull request may close these issues.

4 participants
0