Fixes following review

ocaml · Jan 22, 2025 · a62ed12 · a62ed12
1 parent 900ace0
commit a62ed12
Show file tree

Hide file tree

Showing 2 changed files with 5 additions and 4 deletions.
diff --git a/src/odoc/bin/main.ml b/src/odoc/bin/main.ml
@@ -484,8 +484,8 @@ module Indexing = struct
              || Fpath.has_ext "js" (Fpath.v file)) ->
         Error
           (`Msg
-            "When generating a json index, the output must have a .json file \
-             extension")
+            "When generating a json index, the output must have a .json or .js \
+             file extension")
     | Some file, `Marshall when not (Fpath.has_ext "odoc-index" (Fpath.v file))
       ->
         Error
@@ -542,7 +542,8 @@ module Indexing = struct
     in
     let wrap_json =
       let doc =
-        "whether to wrap the json file. Only has an effect in json output mode."
+        "Not intended for general use. Wraps the json output in a JavaScript \
+         variable assignment, and assumes the use of fuse.js"
       in
       Arg.(value & flag & info ~doc [ "wrap-json" ])
     in

diff --git a/test/search/html_search.t/run.t b/test/search/html_search.t/run.t
@@ -235,7 +235,7 @@ Wrong file extensions:
   ERROR: When generating a binary index, the output must have a .odoc-index file extension
   [1]
   $ odoc compile-index  --json  -o index.odoc-index
-  ERROR: When generating a json index, the output must have a .json file extension
+  ERROR: When generating a json index, the output must have a .json or .js file extension
   [1]
 
 Passing a file which is not a correctly marshalled one: