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

vertically formatting examples #2333

Open
heyitaki opened this issue May 10, 2023 · 1 comment
Open

vertically formatting examples #2333

heyitaki opened this issue May 10, 2023 · 1 comment
Labels

Comments

@heyitaki
Copy link

heyitaki commented May 10, 2023

I'm adding examples to some CLI commands. Please correct me if I'm wrong but as far as I can see, there is no way to either:

  1. Vertically format examples. Currently, the input is aligned to the left and the output to the right. This is an issue because it can make copying the example a pain once it wraps to multiple lines because the wrapped output will also be copied, spliced into every line.
  2. Have newline characters be treated as just that in the description as opposed to paragraph breaks when passing in a multiline string. Either this, or if I use \n, the output is wrapped at around half the normal line length... I was thinking about sticking the example in here, but it's auto inserting a paragraph break between the example command and the output.

Are there any other solutions to vertically format examples such that the entirety of the output is printed below the example command (without a paragraph break)?

@shadowspawn

This comment was marked as resolved.

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

No branches or pull requests

2 participants