Skip to content

Commit

Permalink
docs CLI Reference: make the warning in the beginning less scary
Browse files Browse the repository at this point in the history
I am currently not aware of any severe differences between the generated
markdown and `jj help`, though this could change if we look over the
text carefully or if we start using `clap` features we weren't using
before.
  • Loading branch information
ilyagr committed Jun 16, 2024
1 parent 9c1286a commit 53c93b1
Showing 1 changed file with 1 addition and 5 deletions.
6 changes: 1 addition & 5 deletions docs/cli-reference.md
Original file line number Diff line number Diff line change
Expand Up @@ -10,11 +10,7 @@

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 -->
If you see a significant difference, feel free to file a bug, or a PR to note the difference here.


{%
Expand Down

0 comments on commit 53c93b1

Please sign in to comment.