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

Allow configuration discussion to be moved to end #159

Open
erica opened this issue May 20, 2020 · 4 comments
Open

Allow configuration discussion to be moved to end #159

erica opened this issue May 20, 2020 · 4 comments
Labels
enhancement New feature or request good first issue Good for newcomers

Comments

@erica
Copy link
Contributor

erica commented May 20, 2020

I know this one is a little tenuous but I thought I'd throw it out there and if you don't like it, it can be as easily closed as any other feature request:

A flag that allows the discussion text (CommandConfiguration(discussion: "")) to be displayed at the end of help instead of the beginning so the options are visible to the user in the first screen of more/less. The current output is heavily weighted towards the style of internal code comments instead of the tooling needs of the end-user, who often wants to review the flags, options, arguments (and okay subcommands) quickly, and then use the tool immediately. This is the pattern used for memory refresh.

Reading the full discussion is more typical for someone who is encountering an issue with the tooling and looking for deeper instruction material, and is more typically secondary to casual use. (see also: "full help")

@natecook1000 natecook1000 added the enhancement New feature or request label Jun 11, 2020
@natecook1000
Copy link
Member

Agreed on this, but I think I might want to have three slots available, so it ends up matching the way man pages are often layed out:

$ example --help
Usage: example --foo [bar]
Abstract
Discussion
Argument/flag/option descriptions
Additional info

@erica Do you have any suggestions for a name for “Additional info” here?

@natecook1000
Copy link
Member

Name for this extra configuration property can be extendedDiscussion.

@natecook1000 natecook1000 added the good first issue Good for newcomers label Feb 25, 2021
@arthurcro
Copy link

arthurcro commented Sep 28, 2022

Hey! 👋 Are you still interested in closing issue? I'd love to give it a try!

@natecook1000
Copy link
Member

That would be great, thanks @arthurcro!

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
enhancement New feature or request good first issue Good for newcomers
Projects
None yet
Development

No branches or pull requests

3 participants