Skip to content
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.

Sign up for GitHub

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

Jump to bottom

[DX] Console command description/help #26376

Closed
noniagriconomie opened this issue Mar 2, 2018 · 7 comments
Closed

[DX] Console command description/help #26376

noniagriconomie opened this issue Mar 2, 2018 · 7 comments
Labels
Bug Console DX DX = Developer eXperience (anything that improves the experience of using Symfony) Status: Reviewed

Comments

@noniagriconomie
Copy link
Contributor

noniagriconomie commented Mar 2, 2018 •
edited

Q A
Bug report? maybe
Feature request? maybe
BC Break report? no
RFC? yes
Symfony version 2.7

Hi,

In a console command, we can have a description and an help.
I think it could be better to have the description on top of the --help option output instead of at the end.

  • Description first
  • Usage then
  • Help at the end

before

before

after

after

What do you think?
@chalasr chalasr added Console RFC RFC = Request For Comments (proposals about features that you want to be discussed) labels Mar 2, 2018
@linaori
Copy link
Contributor

linaori commented Mar 3, 2018

Sounds like a good idea to me!

@chalasr
Copy link
Member

chalasr commented Mar 4, 2018

👍

@javiereguiluz javiereguiluz added Bug DX DX = Developer eXperience (anything that improves the experience of using Symfony) and removed RFC RFC = Request For Comments (proposals about features that you want to be discussed) labels Mar 4, 2018
@Simperfit
Copy link
Contributor

@noniagriconomie Do you want to provide a Pull Request for this ?

@noniagriconomie
Copy link
Contributor Author

noniagriconomie commented Mar 5, 2018 •
edited

@Simperfit I can work on it yes
Should i do it on 4.0 ? 3.4 ? Or 2.8 ?
Thank you

@Simperfit
Copy link
Contributor

@noniagriconomie Since this has been tagged as a bug/dx you should do it on the lowest branch that contains the feature, we will treat it as a bugfix.

Thanks for contributing to symfony! :)

@Simperfit
Copy link
Contributor

Status: Reviewed

@noniagriconomie
Copy link
Contributor Author

@Simperfit i will do a PR on 2.7 for this little fix then :)

@noniagriconomie noniagriconomie mentioned this issue Mar 7, 2018
Closed
fabpot added a commit that referenced this issue Mar 10, 2018
@fabpot
feature #26439 [Console] [DX] Fix command description/help display (n…
330cf8d 
…oniagriconomie)

This PR was submitted for the 2.7 branch but it was merged into the 4.1-dev branch instead (closes #26439).

Discussion
----------

[Console] [DX] Fix command description/help display

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

Hi,

Here is a fix for the issue #26376

I only patch the text descriptor, should I do it for others?
(I do not think so as the main and default one is text)

Thanks

Commits
-------

9ca6d62 Fix command description display
@fabpot fabpot closed this as completed Mar 10, 2018
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees
No one assigned
Labels
Bug Console DX DX = Developer eXperience (anything that improves the experience of using Symfony) Status: Reviewed
Projects
None yet
Milestone
No milestone
Development

No branches or pull requests
7 participants
@fabpot @javiereguiluz @linaori @Simperfit @chalasr @noniagriconomie @carsonbot