Closed Tyrrrz closed 3 years ago
Hello @Tyrrrz awesome project! I would like to suggest regarding the format, that instead of following an alignment in which the description is above the command and usage, to show the description on the right side in the same row while still including the command and usage on the left side in the same row, e.g. VS Code CLI
I would like to know if you would prefer this approach?
Hi @es-rene99 The problem is your screenshot shows option descriptions, which are fairly constrained in size. In our case it's a full command usage example which may include many parameters or required options. I would prefer to have two columns, but we can't guarantee that it will actually fit.
I see, yes you're right, in that case I can take a look with the format you proposed, could you please assign me this task?
Sure. Feel free to experiment with the format as much as you wish. Ideally we want to have as little vertical space usage as possible, so that most help text fits on one screen.
Currently, the help text looks like this:
This is a bit suboptimal, for few reasons:
The suggestion is to change the help text to this instead:
Vertical formatting instead of columns because command usage info can get rather large. Generally, the format is up to discussion, so ideas are welcome.