retain super/subscripts in markdown conversion (#1170)

* retain super/subscripts in markdown conversion

* formatting

* changelog

* fix with_pp issue

* promote ts tests

CHANGES.md

@@ -1,5 +1,9 @@
 # Unreleased
 
+## Fixes
+
+- Fix missing super & subscripts in markdown documentation. (#1170)
+
 ## Features
 
 - Display text of references in doc strings (#1166)

ocaml-lsp-server/src/doc_to_md.ml

@@ -57,6 +57,16 @@ let rec inline_element_to_inline
        raw markups, only for blocks. *)
     let meta = loc_to_meta location in
     Inline.Text (text, meta)
+  | { value = `Styled (`Superscript, inlines); location } ->
+    let text = inline_element_list_to_inlines inlines in
+    let meta = loc_to_meta location in
+    Inline.Inlines
+      ([ Inline.Text ("^{", meta); text; Inline.Text ("}", meta) ], meta)
+  | { value = `Styled (`Subscript, inlines); location } ->
+    let text = inline_element_list_to_inlines inlines in
+    let meta = loc_to_meta location in
+    Inline.Inlines
+      ([ Inline.Text ("_{", meta); text; Inline.Text ("}", meta) ], meta)
   | { value = `Styled (style, inlines); location } ->
     let text = inline_element_list_to_inlines inlines in
     let meta = loc_to_meta location in

ocaml-lsp-server/src/ocaml_lsp_server.ml

@@ -1,6 +1,7 @@
 open Import
 module Version = Version
 module Diagnostics = Diagnostics
+module Doc_to_md = Doc_to_md
 module Diff = Diff
 open Fiber.O
 

ocaml-lsp-server/src/ocaml_lsp_server.mli

@@ -2,3 +2,4 @@ val run : Lsp.Cli.Channel.t -> read_dot_merlin:bool -> unit -> unit
 
 module Diagnostics = Diagnostics
 module Version = Version
+module Doc_to_md = Doc_to_md

ocaml-lsp-server/test/e2e-new/doc_to_md.ml

@@ -0,0 +1,17 @@
+open Ocaml_lsp_server.Doc_to_md
+
+let print_doc = function
+  | Raw s -> print_endline s
+  | Markdown s -> print_endline s
+
+let%expect_test "superscript" =
+  let doc = {| 2{^30} |} in
+
+  translate doc |> print_doc;
+  [%expect {| 2^{30} |}]
+
+let%expect_test "subscript" =
+  let doc = {| a{_b} |} in
+
+  translate doc |> print_doc;
+  [%expect {| a\_{b} |}]

ocaml-lsp-server/test/e2e-new/dune

@@ -25,6 +25,7 @@
   jsonrpc
   lsp
   lsp_fiber
+  ocaml_lsp_server
   ;; This is because of the (implicit_transitive_deps false)
   ;; in dune-project
   base
@@ -41,6 +42,7 @@
     action_extract
     action_inline
     code_actions
+    doc_to_md
     document_flow
     for_ppx
     hover_extended

ocaml-lsp-server/test/e2e/__tests__/textDocument-signatureHelp.ts

@@ -364,7 +364,7 @@ describe_opt("textDocument/completion", () => {
               
               #### Inline Formatting
               
-              **Bold**, *Italic*, *Emphasize*, Superscript, Subscript, and \`inline code\`
+              **Bold**, *Italic*, *Emphasize*, ^{Superscript}, \\_{Subscript}, and \`inline code\`
               
               #### Text Alignment