diff --git a/docs/api/await_remove.md b/docs/api/await_remove.md new file mode 100644 index 000000000..502cf8100 --- /dev/null +++ b/docs/api/await_remove.md @@ -0,0 +1 @@ +::: textual.await_remove diff --git a/mkdocs-nav.yml b/mkdocs-nav.yml index f02c74cf0..1a99b75f8 100644 --- a/mkdocs-nav.yml +++ b/mkdocs-nav.yml @@ -142,6 +142,7 @@ nav: - "widgets/tree.md" - API: - "api/app.md" + - "api/await_remove.md" - "api/binding.md" - "api/button.md" - "api/checkbox.md" diff --git a/src/textual/await_remove.py b/src/textual/await_remove.py index f8d61e3ff..602acb27d 100644 --- a/src/textual/await_remove.py +++ b/src/textual/await_remove.py @@ -5,7 +5,11 @@ from typing import Generator class AwaitRemove: - """An awaitable returned by App.remove and DOMQuery.remove.""" + """An awaitable returned by a method that removes DOM nodes. + + Returned by [Widget.remove][textual.widget.Widget.remove] and + [DOMQuery.remove][textual.css.query.DOMQuery.remove]. + """ def __init__(self, finished_flag: Event, task: Task) -> None: """Initialise the instance of ``AwaitRemove``.