(docs) fixed typo (#3660)

highlightjs · Nov 13, 2022 · 526d339 · 526d339
1 parent 3997c9b
commit 526d339
Show file tree

Hide file tree

Showing 2 changed files with 6 additions and 1 deletion.
diff --git a/CHANGES.md b/CHANGES.md
@@ -19,6 +19,10 @@ Grammars:
 - enh(java) add permits keyword to java [MBoegers][]
 - fix(javascript/typescript) correct identifier matching when using numbers [Lachlan Heywood][]
 
+Improvements:
+
+- Documentation typo fix by [Eddymens][]
+
 [matyklug18]: https://github.com/matyklug18
 [Josh Goebel]: https://github.com/joshgoebel
 [Josh Temple]: https://github.com/joshtemple
@@ -29,6 +33,7 @@ Grammars:
 [The Flix Organisation]: https://github.com/flix
 [MBoegers]: https://github.com/MBoegers
 [Lachlan Heywood]: https://github.com/lachieh
+[Eddymens]: https://github.com/eddymens
 
 ## Version 11.6.0
 

diff --git a/docs/api.rst b/docs/api.rst
@@ -15,7 +15,7 @@ highlight
 Core highlighting function.  Accepts the code to highlight (string) and a list of options (object).
 The ``language`` parameter must be present and specify the language name or alias
 of the grammar to be used for highlighting.
-The ``ignoreIllegals`` is an optional parameter than when true forces highlighting
+The ``ignoreIllegals`` is an optional parameter that when ``true`` forces highlighting
 to finish even in case of detecting illegal syntax for the
 language instead of throwing an exception.