doc: add merlin_reader to the (dialect ...) documentation (#10483)

* doc: add `merlin_reader` to the `(dialect ...)` documentation Signed-off-by: Antonio Nuno Monteiro <[email protected]> * Update doc/reference/dune-project/dialect.rst Co-authored-by: Andrey Popp <[email protected]> Signed-off-by: Antonio Nuno Monteiro <[email protected]> * fix: grammar Signed-off-by: Antonio Nuno Monteiro <[email protected]> * fix: use seealso and a stable tag Signed-off-by: Antonio Nuno Monteiro <[email protected]> --------- Signed-off-by: Antonio Nuno Monteiro <[email protected]> Co-authored-by: Andrey Popp <[email protected]> Co-authored-by: Etienne Millon <[email protected]>
ocaml · May 14, 2024 · a55af46 · a55af46
1 parent f4939a4
commit a55af46
Showing 1 changed file with 12 additions and 0 deletions.
diff --git a/doc/reference/dune-project/dialect.rst b/doc/reference/dune-project/dialect.rst
@@ -66,6 +66,18 @@ dialect
 
       .. versionchanged:: 3.9 This field is made optional.
 
+   .. describe:: (merlin_reader <program> <args>...)
+
+      Configure Merlin to use `<program> <args>...` as READER. Merlin's READER
+      is a mechanism to extend Merlin to support OCaml dialects by providing
+      a program that transforms a dialect AST into an OCaml AST.
+
+      .. seealso:: `merlin/src/extend/extend_protocol.ml <https://github.com/ocaml/merlin/blob/4.14-502_preview2/src/extend/extend_protocol.ml>`_ for the protocol specification.
+
+      This field is optional.
+
+      .. versionadded:: 3.16
+
 
 Default dialects
 ----------------