aboutsummaryrefslogtreecommitdiffstats
diff options
context:
space:
mode:
Diffstat (limited to '')
-rw-r--r--readme.md4
1 files changed, 2 insertions, 2 deletions
diff --git a/readme.md b/readme.md
index 8404705..e13c30c 100644
--- a/readme.md
+++ b/readme.md
@@ -285,8 +285,8 @@ user-provided markdown opens you up to XSS attacks.
An aspect related to XSS for security is syntax errors: markdown itself has no
syntax errors.
Some syntax extensions (specifically, only MDX) do include syntax errors.
-For that reason, `micromark_with_options` returns `Result<(), String>`, of which
-the error is a simple string indicating where the problem happened, what
+For that reason, `micromark_with_options` returns `Result<String, String>`, of
+which the error is a simple string indicating where the problem happened, what
occurred, and what was expected instead.
Make sure to handle your errors when using MDX.