From 4b16c3315e3ea390ba3bac4746b9422046cd78ad Mon Sep 17 00:00:00 2001 From: Steven Wu Date: Fri, 18 Oct 2024 15:00:25 -0400 Subject: [PATCH] Apply suggestions from code review Co-authored-by: margaretkennedy <82049573+margaretkennedy@users.noreply.github.com> --- plugins/ui/docs/components/markdown.md | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/plugins/ui/docs/components/markdown.md b/plugins/ui/docs/components/markdown.md index 31992c1eb..65e44d50d 100644 --- a/plugins/ui/docs/components/markdown.md +++ b/plugins/ui/docs/components/markdown.md @@ -1,6 +1,6 @@ # Markdown -The markdown components renders a string in the CommonMark standard. The component also supports LaTeX (through MathJax), with `remark-math` and `rehype-mathjax`. Other plugins and markdown components are not supported. The markdown is wrapped in a `View`, which all props are passed to except for `children`. +The markdown component renders a string in the CommonMark standard. It also supports LaTeX (through MathJax), with `remark-math` and `rehype-mathjax`. Other plugins and markdown components are not supported. The markdown is wrapped in a `View`, which all props are passed to except for `children`. For individual lines of text, consider using `ui.text` and `ui.heading` instead. @@ -37,7 +37,7 @@ ui_markdown_example = ui_markdown() ## LaTeX -When writing LaTeX, be careful on how Python handles backslashes with escape characters. It is recommended to use raw strings to minimize this issue. +When writing LaTeX, be careful how Python handles backslashes with escape characters. To minimize this issue, it is recommended to use raw strings. ```python from deephaven import ui