From 6f3c9205cd2184e59fd718f792abe2bd0984b651 Mon Sep 17 00:00:00 2001 From: Sidharth Vinod Date: Fri, 8 Dec 2023 09:45:49 +0530 Subject: [PATCH 1/2] Update packages/mermaid/src/docs/config/usage.md Co-authored-by: Alois Klink --- packages/mermaid/src/docs/config/usage.md | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/packages/mermaid/src/docs/config/usage.md b/packages/mermaid/src/docs/config/usage.md index cd22bc38c..1f5866533 100644 --- a/packages/mermaid/src/docs/config/usage.md +++ b/packages/mermaid/src/docs/config/usage.md @@ -334,9 +334,9 @@ The `mermaid.parse(text, parseOptions)` function validates graph definitions wit The function `mermaid.parse(text, parseOptions)`, takes a text string as an argument and returns `{ diagramType: string }` if the definition follows mermaid's syntax. -If the definition is invalid, the function returns `false` if `parseOptions.supressError` is set to `true`. Otherwise, it throws an error. +If the definition is invalid, the function returns `false` if `parseOptions.suppressErrors` is set to `true`. Otherwise, it throws an error. -The parseError function will be called when the parse function throws an error. It will not be called if `parseOptions.supressError` is set to `true`. +The parseError function will be called when the parse function throws an error. It will not be called if `parseOptions.suppressErrors` is set to `true`. It is possible to override this function in order to handle the error in an application-specific way. From 45880395ea72bf5c6cc69d6065da90c14a684e88 Mon Sep 17 00:00:00 2001 From: sidharthv96 Date: Fri, 8 Dec 2023 04:18:24 +0000 Subject: [PATCH 2/2] Update docs --- docs/config/usage.md | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/docs/config/usage.md b/docs/config/usage.md index afd8e992a..bb8b903a7 100644 --- a/docs/config/usage.md +++ b/docs/config/usage.md @@ -337,9 +337,9 @@ The `mermaid.parse(text, parseOptions)` function validates graph definitions wit The function `mermaid.parse(text, parseOptions)`, takes a text string as an argument and returns `{ diagramType: string }` if the definition follows mermaid's syntax. -If the definition is invalid, the function returns `false` if `parseOptions.supressError` is set to `true`. Otherwise, it throws an error. +If the definition is invalid, the function returns `false` if `parseOptions.suppressErrors` is set to `true`. Otherwise, it throws an error. -The parseError function will be called when the parse function throws an error. It will not be called if `parseOptions.supressError` is set to `true`. +The parseError function will be called when the parse function throws an error. It will not be called if `parseOptions.suppressErrors` is set to `true`. It is possible to override this function in order to handle the error in an application-specific way.