describe: add comments to describe_common

Signed-off-by: Ali Caglayan <alizter@gmail.com>
ocaml · Jun 9, 2023 · 50f3035 · 50f3035
1 parent ac0ad41
commit 50f3035
Showing 1 changed file with 6 additions and 0 deletions.
diff --git a/bin/describe/describe_common.mli b/bin/describe/describe_common.mli
@@ -1,6 +1,12 @@
 open Import
 open Stdune
 
+(** Common library for "dune describe" style commands. This module contains two
+    modules:
+
+    - [Desc] which is a description of a workspace that can be serialised.
+    - [Format] which provides outputs serialisation support for a command. *)
+
 (** The module [Descr] is a typed representation of the description of a
     workspace, that is provided by the ``dune describe workspace`` command.