File tree Expand file tree Collapse file tree 2 files changed +5
-3
lines changed Expand file tree Collapse file tree 2 files changed +5
-3
lines changed Original file line number Diff line number Diff line change @@ -1068,13 +1068,13 @@ async def _on_mount(self, _: Mount) -> None:
1068
1068
1069
1069
@classmethod
1070
1070
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.
1072
1072
1073
1073
If you append to the Markdown document many times a second, it is possible the widget won't
1074
1074
be able to update as fast as you write (occurs around 20 appends per second). It will still
1075
1075
work, but the user will have to wait for the UI to catch up after the document has be retrieved.
1076
1076
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
1078
1078
as necessary to keep up with the incoming data.
1079
1079
1080
1080
example:
Original file line number Diff line number Diff line change 1
1
from textual .widgets ._markdown import (
2
2
Markdown ,
3
3
MarkdownBlock ,
4
+ MarkdownStream ,
4
5
MarkdownTableOfContents ,
5
6
TableOfContentsType ,
6
7
)
7
8
8
9
__all__ = [
9
- "MarkdownTableOfContents" ,
10
10
"Markdown" ,
11
11
"MarkdownBlock" ,
12
+ "MarkdownStream" ,
13
+ "MarkdownTableOfContents" ,
12
14
"TableOfContentsType" ,
13
15
]
You can’t perform that action at this time.
0 commit comments