Merge pull request #9427 from Octachron/ocamldoc_list_syntax

ocamldoc: fix the printing of (::)
ocaml · Sep 8, 2020 · 9f804a2 · 9f804a2
2 parents 6db41e4 + 1393a37
commit 9f804a2
Show file tree

Hide file tree

Showing 2 changed files with 10 additions and 1 deletion.
diff --git a/Changes b/Changes
@@ -382,6 +382,9 @@ Working version
 - #8747, #9709: incorrect principality warning on functional updates of records
   (Jacques Garrigue, report and review by Thomas Refis)
 
+- #9421, #9427: fix printing of (::) in ocamldoc
+  (Florian Angeletti, report by Yawar Amin, review by Damien Doligez)
+
 - #9469: Better backtraces for lazy values
   (Leo White, review by Nicolás Ojeda Bär)
 

diff --git a/ocamldoc/odoc_sig.ml b/ocamldoc/odoc_sig.ml
@@ -388,8 +388,14 @@ module Analyser =
               | Cstr_record l ->
                   Cstr_record (List.map (get_field env name_comment_list) l)
             in
+            let vc_name = match constructor_name with
+              | "::" ->
+                  (* The only infix constructor is always printed (::) *)
+                  "(::)"
+              | s -> s
+            in
             {
-              vc_name = constructor_name ;
+              vc_name;
               vc_args;
               vc_ret =  Option.map (Odoc_env.subst_type env) ret_type;
               vc_text = comment_opt