test_generate_cli_reference: Fixup to 16ec185

That old commit made a piece of documentation obsolete, but I didn't realize it at the time.
jj-vcs · Jun 16, 2024 · 726ceb8 · 726ceb8
1 parent 53c93b1
commit 726ceb8
Show file tree

Hide file tree

Showing 2 changed files with 4 additions and 7 deletions.
diff --git a/cli/tests/[email protected] b/cli/tests/[email protected]
@@ -1,6 +1,6 @@
 ---
 source: cli/tests/test_generate_md_cli_help.rs
-description: "AUTO-GENERATED FILE, DO NOT EDIT. This cli reference is generated as an `insta` snapshot. MkDocs follows they symlink from docs/cli-reference.md to the snap. Unfortunately, `insta` unavoidably creates this header. Luckily, MkDocs ignores the header since it has the same format as Markdown headers. TODO: MkDocs may fail on Windows if symlinks are not enabled in the OS settings"
+description: "AUTO-GENERATED FILE, DO NOT EDIT. This cli reference is generated by a test as an `insta` snapshot. MkDocs includes this snapshot from docs/cli-reference.md."
 ---
 <!-- BEGIN MARKDOWN-->
 

diff --git a/cli/tests/test_generate_md_cli_help.rs b/cli/tests/test_generate_md_cli_help.rs
@@ -33,12 +33,9 @@ fn test_generate_markdown_docs_in_docs_dir() {
         snapshot_suffix => ".md",
         prepend_module_to_snapshot => false,
         omit_expression => true,
-        description => "AUTO-GENERATED FILE, DO NOT EDIT. This cli reference is generated as an \
-                        `insta` snapshot. MkDocs follows they symlink from docs/cli-reference.md \
-                        to the snap. Unfortunately, `insta` unavoidably creates this header. Luckily, \
-                        MkDocs ignores the header since it has the same format as Markdown headers. \
-                        TODO: MkDocs may fail on Windows if symlinks are not enabled in the OS \
-                        settings",
+        description => "AUTO-GENERATED FILE, DO NOT EDIT. This cli reference is generated \
+                        by a test as an `insta` snapshot. MkDocs includes this snapshot \
+                        from docs/cli-reference.md.",
     },
     { assert_snapshot!("cli-reference", markdown_help) });
 }