arcanis / clipanion

Type-safe CLI library / framework with no runtime dependencies
https://mael.dev/clipanion/
1.12k stars 66 forks source link

refactor: improve option definitions #46

Closed paul-soporan closed 4 years ago

paul-soporan commented 4 years ago

I've experimented with using the option descriptions inside Yarn's CLI docs, but the option definitions have a few problems:

Also, the descriptions weren't formatted as markdown(ish) on the Command help page (useful to highlight backticks).

A small proof of concept of what the option descriptions could look like inside Yarn's CLI docs (after this PR is merged):

image

arcanis commented 4 years ago

Released in 2.6.1 👍