Skip to content

Commit

Permalink
docs CLI reference: explain that argument help is truncated
Browse files Browse the repository at this point in the history
Perhaps this will help with issues like
#3667
  • Loading branch information
ilyagr committed May 15, 2024
1 parent c9b44f3 commit 0d0f8af
Showing 1 changed file with 7 additions and 1 deletion.
8 changes: 7 additions & 1 deletion docs/cli-reference.md
Original file line number Diff line number Diff line change
Expand Up @@ -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 -->


{%
Expand Down

0 comments on commit 0d0f8af

Please sign in to comment.