From 5838a78237c0ae0c5a5cb90f3654963a2093cb48 Mon Sep 17 00:00:00 2001 From: "David L. Qiu" Date: Thu, 31 Oct 2024 11:28:48 -0700 Subject: [PATCH] update docstring --- .../jupyter-ai/src/components/rendermime-markdown.tsx | 8 ++++++-- 1 file changed, 6 insertions(+), 2 deletions(-) diff --git a/packages/jupyter-ai/src/components/rendermime-markdown.tsx b/packages/jupyter-ai/src/components/rendermime-markdown.tsx index d0204d31f..080247ebd 100644 --- a/packages/jupyter-ai/src/components/rendermime-markdown.tsx +++ b/packages/jupyter-ai/src/components/rendermime-markdown.tsx @@ -24,8 +24,12 @@ type RendermimeMarkdownProps = { }; /** - * Escapes LaTeX delimiters and single dollar signs by adding extra backslashes. - * Required for proper rendering of LaTeX markup by `@jupyterlab/rendermime`. + * Escapes backslashes in LaTeX delimiters such that they appear in the DOM + * after the initial MarkDown render. For example, this function takes '\(` and + * returns `\\(`. + * + * Required for proper rendering of MarkDown + LaTeX markup in the chat by + * `ILatexTypesetter`. */ function escapeLatexDelimiters(text: string) { return text