Fix description of onWarning (#460)

nodeca · Dec 16, 2018 · 00bba11 · 00bba11
1 parent 2d1fbed
commit 00bba11
Showing 1 changed file with 1 addition and 1 deletion.
diff --git a/README.md b/README.md
@@ -104,7 +104,7 @@ options:
 - `filename` _(default: null)_ - string to be used as a file path in
   error/warning messages.
 - `onWarning` _(default: null)_ - function to call on warning messages.
-  Loader will throw on warnings if this function is not provided.
+  Loader will call this function with an instance of `YAMLException` for each warning.
 - `schema` _(default: `DEFAULT_SAFE_SCHEMA`)_ - specifies a schema to use.
   - `FAILSAFE_SCHEMA` - only strings, arrays and plain objects:
     http://www.yaml.org/spec/1.2/spec.html#id2802346