Format-dune-file: document that this is low level (#1828)

Signed-off-by: Etienne Millon <me@emillon.org>
ocaml · Feb 11, 2019 · 8aad98a · 8aad98a
1 parent a870484
commit 8aad98a
Showing 1 changed file with 3 additions and 1 deletion.
diff --git a/bin/format_dune_file.ml b/bin/format_dune_file.ml
@@ -8,7 +8,9 @@ let doc = "Format dune files"
 let man =
   [ `S "DESCRIPTION"
   ; `P {|$(b,dune format-dune-file) reads a dune file and outputs a formatted
-           version. |}
+           version. This is a low-level command, meant to implement editor
+           support for example. To reformat a dune project, see the "Automatic
+           formatting" section in the manual.|}
   ]
 
 let info = Term.info "format-dune-file" ~doc ~man