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

improve -help text #578

Open
VladimirAlexiev opened this issue Jul 1, 2021 · 1 comment
Open

improve -help text #578

VladimirAlexiev opened this issue Jul 1, 2021 · 1 comment

Comments

@VladimirAlexiev
Copy link
Contributor

VladimirAlexiev commented Jul 1, 2021

Plantuml -help returns a very useful description of command line options.

However @arnaudroques it can take some improvement to make it more readable.

  • line-up all descriptions vertically. The longest option is -encodesprite 4|8|16[z] "file" and is not too long
  • use just 2 spaces before options
  • remove the parasitic word "To" from descriptions
  • start descriptions with lowercase for consistency

Example showing all these points:

 -checkmetadata                  skip PNG files that don't need to be regenerated
 -p[ipe]                         use stdin for PlantUML source and stdout for PNG/SVG/EPS generation
 -encodesprite 4|8|16[z] "file"  encode a sprite at gray level (z for compression) from an image
 -computeurl|-encodeurl          compute the encoded URL of a PlantUML source file
 -decodeurl                      retrieve the PlantUML source from an encoded URL
  • in this option, two \t are shown instead of lining-up the description:
    -theme xxx\t\tTo use a specific theme
  • use a single tab to line-up descriptions (from the above item it appears you use 1 or 2 tabs)
@VladimirAlexiev
Copy link
Contributor Author

VladimirAlexiev commented Apr 29, 2024

Thanks @The-Lum ! I forget in 2 days, but github and the crowd remember forever :-)
Should we keep this open until your comment is fixed: #1753 (comment)

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

1 participant