Skip to content

Commit

Permalink
Apply suggestions from code review
Browse files Browse the repository at this point in the history
Co-authored-by: margaretkennedy <[email protected]>
  • Loading branch information
wusteven815 and margaretkennedy authored Oct 18, 2024
1 parent 166f3e2 commit 4b16c33
Showing 1 changed file with 2 additions and 2 deletions.
4 changes: 2 additions & 2 deletions plugins/ui/docs/components/markdown.md
Original file line number Diff line number Diff line change
@@ -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.

Expand Down Expand Up @@ -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
Expand Down

0 comments on commit 4b16c33

Please sign in to comment.