From 0d0f8af05de669dbacb5ae620961b556e4640107 Mon Sep 17 00:00:00 2001
From: Ilya Grigoriev <ilyagr@users.noreply.github.com>
Date: Tue, 14 May 2024 22:43:15 -0700
Subject: [PATCH] docs CLI reference: explain that argument help is truncated

Perhaps this will help with issues like
https://github.com/martinvonz/jj/issues/3667
---
 docs/cli-reference.md | 8 +++++++-
 1 file changed, 7 insertions(+), 1 deletion(-)

diff --git a/docs/cli-reference.md b/docs/cli-reference.md
index 006789ce7..5314592b5 100644
--- a/docs/cli-reference.md
+++ b/docs/cli-reference.md
@@ -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 -->
 
 
 {%