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

Preserve more structure in Help #138

Open
reibitto opened this issue Jan 25, 2020 · 1 comment
Open

Preserve more structure in Help #138

reibitto opened this issue Jan 25, 2020 · 1 comment

Comments

@reibitto
Copy link

This idea originated from #126

Basically, if the structure of the error is preserved, it'll be possible to write a custom render function for Help. This can have uses such as for localization and different render formats (in my particular case, "compact" mode which renders with fewer newlines).

@bkirwi bkirwi changed the title Preserve structure Help error Preserve more structure in Help Apr 23, 2022
@bkirwi
Copy link
Owner

bkirwi commented Apr 23, 2022

For context, there's a little structure in Help already... the command name, usage, errors, and the main body are stored separately. There's lots of opportunity to add more structure here, though... for example, preserving more information about individual options than one big string of help output.

This is unlikely to require a big redesign or anything, and should be possible to do ~incrementally; happy to review PRs with this shape.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

No branches or pull requests

2 participants