From a22215bd087a1251698cf26143f4eddc137a7608 Mon Sep 17 00:00:00 2001 From: Alex Fedoseev Date: Fri, 20 Mar 2020 12:40:30 +0300 Subject: [PATCH] Add Caveats doc --- docs/09-I18n.md | 2 +- docs/10-Caveats.md | 17 +++++++++++++++++ docs/{10-API.md => 11-API.md} | 0 3 files changed, 18 insertions(+), 1 deletion(-) create mode 100644 docs/10-Caveats.md rename docs/{10-API.md => 11-API.md} (100%) diff --git a/docs/09-I18n.md b/docs/09-I18n.md index 906b339c..7f2bbe51 100644 --- 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 new file mode 100644 index 00000000..7c8fbd9b --- /dev/null +++ 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 b/docs/11-API.md similarity index 100% rename from docs/10-API.md rename to docs/11-API.md