Skip to content

Commit b32fff4

Browse files
committed
doc fixes
1 parent f565623 commit b32fff4

File tree

2 files changed

+5
-3
lines changed

2 files changed

+5
-3
lines changed

src/textual/widgets/_markdown.py

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1068,13 +1068,13 @@ async def _on_mount(self, _: Mount) -> None:
10681068

10691069
@classmethod
10701070
def get_stream(cls, markdown: Markdown) -> MarkdownStream:
1071-
"""Get a [MarkdownStream][textual.widgets._markdown.MarkdownStream] instance stream Markdown in the background.
1071+
"""Get a [MarkdownStream][textual.widgets.markdown.MarkdownStream] instance stream Markdown in the background.
10721072
10731073
If you append to the Markdown document many times a second, it is possible the widget won't
10741074
be able to update as fast as you write (occurs around 20 appends per second). It will still
10751075
work, but the user will have to wait for the UI to catch up after the document has be retrieved.
10761076
1077-
Using a [MarkdownStream][textual.widgets._markdown.MarkdownStream] will combine several updates in to one
1077+
Using a [MarkdownStream][textual.widgets.markdown.MarkdownStream] will combine several updates in to one
10781078
as necessary to keep up with the incoming data.
10791079
10801080
example:

src/textual/widgets/markdown.py

Lines changed: 3 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,13 +1,15 @@
11
from textual.widgets._markdown import (
22
Markdown,
33
MarkdownBlock,
4+
MarkdownStream,
45
MarkdownTableOfContents,
56
TableOfContentsType,
67
)
78

89
__all__ = [
9-
"MarkdownTableOfContents",
1010
"Markdown",
1111
"MarkdownBlock",
12+
"MarkdownStream",
13+
"MarkdownTableOfContents",
1214
"TableOfContentsType",
1315
]

0 commit comments

Comments
 (0)