Closed paul-soporan closed 4 years ago
I've experimented with using the option descriptions inside Yarn's CLI docs, but the option definitions have a few problems:
options
options[].definition
-p,--package #0
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):
Released in 2.6.1 👍
I've experimented with using the option descriptions inside Yarn's CLI docs, but the option definitions have a few problems:
options
field also included options without descriptions.options[].definition
field was simply a join rather than a full definition (which should also include the arity --p,--package #0
)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):