docs CLI reference: explain that argument help is truncated

Perhaps this will help with issues like
https://github.com/martinvonz/jj/issues/3667
This commit is contained in:
Ilya Grigoriev 2024-05-14 22:43:15 -07:00
parent c9b44f3828
commit 0d0f8af05d

View file

@ -8,7 +8,13 @@
This CLI reference is experimental. It is automatically generated, but
does not match the `jj help` output exactly.
<!-- See also https://github.com/ConnorGray/clap-markdown/issues -->
Run `jj help <COMMAND>` for more authoritative documentation.
For example, each argument for each command will show only one
paragraph of documentation on this page, even if `jj help` would
show multiple paragraphs with additional details.
<!-- https://github.com/ConnorGray/clap-markdown/issues/20 -->
{%