Skip to content

Commit b7d5c1d

Browse files
committed
Mark experimental commands as experimental
Signed-off-by: Paul-Elliot <peada@free.fr>
1 parent 0153ccf commit b7d5c1d

File tree

1 file changed

+11
-10
lines changed

1 file changed

+11
-10
lines changed

src/odoc/bin/main.ml

Lines changed: 11 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -351,9 +351,9 @@ module Source_tree = struct
351351

352352
let info ~docs =
353353
let doc =
354-
"Compile a source tree into a page. Expect a text file containing the \
355-
relative paths to every source files in the source tree. The paths \
356-
should be the same as the one passed to $(i,odoc compile \
354+
"(EXPERIMENTAL) Compile a source tree into a page. Expect a text file \
355+
containing the relative paths to every source files in the source tree. \
356+
The paths should be the same as the one passed to $(i,odoc compile \
357357
--source-name)."
358358
in
359359
Term.info "source-tree" ~docs ~doc
@@ -449,8 +449,9 @@ module Compile_src = struct
449449

450450
let info ~docs =
451451
let doc =
452-
"Compile a $(i,NAME.cmt) file to a $(i,src-NAME.odoc) containing the \
453-
implementation information needed by odoc for the compilation unit."
452+
"(EXPERIMENTAL) Compile a $(i,NAME.cmt) file to a $(i,src-NAME.odoc) \
453+
containing the implementation information needed by odoc for the \
454+
compilation unit."
454455
in
455456
Term.info "compile-src" ~docs ~doc
456457
end
@@ -671,8 +672,8 @@ end = struct
671672

672673
let source_file =
673674
let doc =
674-
"Source code for the compilation unit. It must have been compiled with \
675-
--source-parent passed."
675+
"(EXPERIMENTAL) Source code for the compilation unit. It must have \
676+
been compiled with --source-parent passed."
676677
in
677678
Arg.(
678679
value
@@ -681,9 +682,9 @@ end = struct
681682

682683
let source_root =
683684
let doc =
684-
"Source code root for the compilation unit. Used to find the source \
685-
file from the value of --source-name it was compiled with. \
686-
Incompatible with --source-file."
685+
"(EXPERIMENTAL) Source code root for the compilation unit. Used to \
686+
find the source file from the value of --source-name it was compiled \
687+
with. Incompatible with --source-file."
687688
in
688689
Arg.(
689690
value

0 commit comments

Comments
 (0)