Add Caveats doc

shakacode · Mar 20, 2020 · a22215b · a22215b
1 parent 3445c85
commit a22215b
Show file tree

Hide file tree

Showing 3 changed files with 18 additions and 1 deletion.
diff --git a/docs/09-I18n.md b/docs/09-I18n.md
@@ -9,4 +9,4 @@ Then errors returned from all validators must be of this type.
 
 ---
 
-Next: **[API →](./10-API.md)**
+Next: **[Caveats →](./10-Caveats.md)**
diff --git a/docs/10-Caveats.md b/docs/10-Caveats.md
@@ -0,0 +1,17 @@
+# Caveats
+## Warning 42
+This warning is disabled by default but if you explicitly enabled it, you might see the following message during a compilation:
+
+```
+Warning 42: this use of [field] relies on type-directed disambiguation, it will not compile with OCaml 4.00 or earlier.
+```
+
+To get rid of it, consider to disable it either globally via `bsconfig.json` or locally in form modules:
+
+```reason
+[@ocaml.warning "-42"];
+```
+
+---
+
+Next: **[API →](./10-API.md)**
diff --git a/docs/10-API.md → docs/11-API.md b/docs/10-API.md → docs/11-API.md