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.

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

Proposal: Re-add padding to margins #1818

Closed
ctjlewis opened this issue Nov 9, 2022 · 4 comments
Closed

Proposal: Re-add padding to margins #1818

ctjlewis opened this issue Nov 9, 2022 · 4 comments

Comments

@ctjlewis
Copy link

ctjlewis commented Nov 9, 2022

Could we pretty, pretty please consider readding left/top/bottom padding? Just a little two-space iiiiiiiitty bitty little bit of wiggle room to prevent eye strain?

If you wish to propose changes, make your case in a more civil manner.

I am very sorry for my last issue, where I harshly suggested that we revert a change which moved this tool to "bleeding eyes mode." That was very insensitive of me. It was also harsh of me to criticize the contributor who campaigned vigorously for removing all padding, and for recommending that you "do the opposite of whatever he says." All of this was extremely inappropriate and I am learning to do better.

@shadowspawn
Copy link
Collaborator

shadowspawn commented Nov 9, 2022

The changes removing the padding were made with extensive references to other programs which did not have leading or trailing empty lines for the help, or leading spaces before the Usage/Options/Commands titles. I recall being a little surprised at the time (before I was a maintainer) because I was used to the previous behaviour in my own program and had formatted my help additions to match Commander layout. But when I looked around I agreed the changes made Commander's help more consistent with general usage.

The two most familiar are git and npm.

Checking Yargs as the closest peer of Commander. In a small sample program, it does not add leading or trailing empty lines, or leading spaces before the help titles.

Looking at man as the canonical help format, it does not have leading or trailing empty lines, or leading spaces before the help titles. It does have whitespace just after the header and just before the trailer.

What other programs do you use that include left/top/bottom padding?

@shadowspawn
Copy link
Collaborator

Coming after the original discussion and changes, there is now an easy way to add leading and trailing text to the help (without subclassing). See .addHelpText().

@shadowspawn
Copy link
Collaborator

Related issues: #608 #741 #832 #852 #853

@shadowspawn shadowspawn changed the title Proposal: Readd padding to margins Proposal: Re-add padding to margins Nov 9, 2022
@shadowspawn
Copy link
Collaborator

No activity or further information in a month.

Feel free to open a new issue if it comes up again, with new information and renewed interest.

@shadowspawn shadowspawn closed this as not planned Won't fix, can't repro, duplicate, stale Dec 9, 2022
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

No branches or pull requests

2 participants