Add missing parentheses around identifier 'let*'

Julow · Dec 20, 2024 · 20010b2 · 20010b2
1 parent 0677e3f
commit 20010b2
Show file tree

Hide file tree

Showing 4 changed files with 23 additions and 23 deletions.
diff --git a/src/model/names.ml b/src/model/names.ml
@@ -1,19 +1,19 @@
+(** Returns [true] on chars that are part of operators. *)
+let operator_char = function
+  (* https://ocaml.org/manual/5.2/lex.html#core-operator-char *)
+  | '$' | '&' | '*' | '+' | '-' | '/' | '=' | '>' | '@' | '^' | '|' | '~' | '!'
+  | '?' | '%' | '<' | ':' | '.'
+  (* https://ocaml.org/manual/5.2/lex.html#infix-symbol *)
+  | '#'
+  (* https://ocaml.org/manual/5.2/indexops.html#s:index-operators *)
+  | '(' | ')' | '[' | ']' | '{' | '}' ->
+      true
+  | _ -> false
+
 let parenthesise name =
   match name with
   | "asr" | "land" | "lor" | "lsl" | "lsr" | "lxor" | "mod" -> "(" ^ name ^ ")"
-  | _ ->
-      if String.length name > 0 then
-        match name.[0] with
-        | 'a' .. 'z'
-        | '\223' .. '\246'
-        | '\248' .. '\255'
-        | '_'
-        | 'A' .. 'Z'
-        | '\192' .. '\214'
-        | '\216' .. '\222' ->
-            name
-        | _ -> "(" ^ name ^ ")"
-      else name
+  | _ -> if String.exists operator_char name then "(" ^ name ^ ")" else name
 
 let contains_double_underscore s =
   let len = String.length s in

diff --git a/test/generators/html/Ocamlary-Op.html b/test/generators/html/Ocamlary-Op.html
@@ -17,15 +17,15 @@ <h1>Module <code><span>Ocamlary.Op</span></code></h1>
   </header>
   <div class="odoc-content">
    <div class="odoc-spec">
-    <div class="spec value anchored" id="val-let*">
-     <a href="#val-let*" class="anchor"></a>
-     <code><span><span class="keyword">val</span> let* : int</span></code>
+    <div class="spec value anchored" id="val-(let*)">
+     <a href="#val-(let*)" class="anchor"></a>
+     <code><span><span class="keyword">val</span> (let*) : int</span></code>
     </div>
    </div>
    <div class="odoc-spec">
-    <div class="spec value anchored" id="val-and*">
-     <a href="#val-and*" class="anchor"></a>
-     <code><span><span class="keyword">val</span> and* : int</span></code>
+    <div class="spec value anchored" id="val-(and*)">
+     <a href="#val-(and*)" class="anchor"></a>
+     <code><span><span class="keyword">val</span> (and*) : int</span></code>
     </div>
    </div>
    <div class="odoc-spec">

diff --git a/test/generators/latex/Ocamlary.tex b/test/generators/latex/Ocamlary.tex
@@ -895,8 +895,8 @@ \subsection{New reference syntax\label{new-reference-syntax}}%
 \label{Ocamlary-module-type-TypeExtPruned-val-f}\ocamlcodefragment{\ocamltag{keyword}{val} f : \hyperref[Ocamlary-type-new_t]{\ocamlinlinecode{new\_\allowbreak{}t}} \ocamltag{arrow}{$\rightarrow$} unit}\\
 \end{ocamlindent}%
 \ocamlcodefragment{\ocamltag{keyword}{end}}\\
-\label{Ocamlary-module-Op}\ocamlcodefragment{\ocamltag{keyword}{module} \hyperref[Ocamlary-Op]{\ocamlinlinecode{Op}}}\ocamlcodefragment{ : \ocamltag{keyword}{sig}}\begin{ocamlindent}\label{Ocamlary-Op-val-let*}\ocamlcodefragment{\ocamltag{keyword}{val} let* : int}\\
-\label{Ocamlary-Op-val-and*}\ocamlcodefragment{\ocamltag{keyword}{val} and* : int}\\
+\label{Ocamlary-module-Op}\ocamlcodefragment{\ocamltag{keyword}{module} \hyperref[Ocamlary-Op]{\ocamlinlinecode{Op}}}\ocamlcodefragment{ : \ocamltag{keyword}{sig}}\begin{ocamlindent}\label{Ocamlary-Op-val-(let*)}\ocamlcodefragment{\ocamltag{keyword}{val} (let*) : int}\\
+\label{Ocamlary-Op-val-(and*)}\ocamlcodefragment{\ocamltag{keyword}{val} (and*) : int}\\
 \label{Ocamlary-Op-val-(.+p++ob++cb+)}\ocamlcodefragment{\ocamltag{keyword}{val} (.\allowbreak{}\%\{\}) : int}\\
 \label{Ocamlary-Op-val-(.+p++ob++cb+<-)}\ocamlcodefragment{\ocamltag{keyword}{val} (.\allowbreak{}\%\{\}<-) : int}\\
 \label{Ocamlary-Op-val-(.+p++ob+;..+cb+)}\ocamlcodefragment{\ocamltag{keyword}{val} (.\allowbreak{}\%\{;\allowbreak{}.\allowbreak{}.\allowbreak{}\}) : int}\\

diff --git a/test/generators/man/Ocamlary.Op.3o b/test/generators/man/Ocamlary.Op.3o
@@ -11,9 +11,9 @@ Ocamlary\.Op
 .SH Documentation
 .sp 
 .nf 
-\f[CB]val\fR let* : int
+\f[CB]val\fR (let*) : int
 .sp 
-\f[CB]val\fR and* : int
+\f[CB]val\fR (and*) : int
 .sp 
 \f[CB]val\fR (\.%{}) : int
 .sp