aboutsummaryrefslogtreecommitdiffstats
diff options
context:
space:
mode:
authorLibravatar Titus Wormer <tituswormer@gmail.com>2022-10-12 17:50:42 +0200
committerLibravatar Titus Wormer <tituswormer@gmail.com>2022-10-12 17:50:42 +0200
commit861af95c119721e814460fa7dc32bd3d74b38484 (patch)
tree18647b5b7405c3904c61ec15d83345af8dd69b4b
parent54d84a4fd326dcfae871e203d673d55cbf40a279 (diff)
downloadmarkdown-rs-861af95c119721e814460fa7dc32bd3d74b38484.tar.gz
markdown-rs-861af95c119721e814460fa7dc32bd3d74b38484.tar.bz2
markdown-rs-861af95c119721e814460fa7dc32bd3d74b38484.zip
Fix typo
-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.