From cd25e70d1623ac5bd50be1ca2b30db793063c1cc Mon Sep 17 00:00:00 2001
From: Chimrod <>
Date: Mon, 9 Dec 2024 10:38:12 +0100
Subject: Added documentation

---
 lib/checks/get_type.ml        | 7 ++++++-
 lib/checks/nested_strings.mli | 2 ++
 2 files changed, 8 insertions(+), 1 deletion(-)

(limited to 'lib/checks')

diff --git a/lib/checks/get_type.ml b/lib/checks/get_type.ml
index b34dc17..a73eb1b 100644
--- a/lib/checks/get_type.ml
+++ b/lib/checks/get_type.ml
@@ -1,3 +1,8 @@
+(** This module extract the type for an expression.
+
+    The module does not check anything, but is intended to be composed in
+    another one check. *)
+
 open StdLabels
 module S = Qsp_syntax.S
 module T = Qsp_syntax.T
@@ -5,7 +10,7 @@ module Report = Qsp_syntax.Report
 
 type type_of =
   | Integer  (** A numeric value *)
-  | Bool  (** A boolean, not a real type  *)
+  | Bool  (** A boolean, not a real type *)
   | String  (** String value *)
   | NumericString
       [@printer fun fmt _ -> Format.pp_print_string fmt "Integer as String"]
diff --git a/lib/checks/nested_strings.mli b/lib/checks/nested_strings.mli
index 6446c67..1ef2e33 100644
--- a/lib/checks/nested_strings.mli
+++ b/lib/checks/nested_strings.mli
@@ -1 +1,3 @@
 include Qsp_syntax.S.Analyzer
+(** The module [Nested_strings] report errors for each unnecessary raw string
+    encoded inside a string expression *)
-- 
cgit v1.2.3