Document AwaitRemove

This commit is contained in:
Dave Pearson
2023-02-28 12:50:41 +00:00
parent 8d2336a02e
commit ce5b02522e
3 changed files with 7 additions and 1 deletions

1
docs/api/await_remove.md Normal file
View File

@@ -0,0 +1 @@
::: textual.await_remove

View File

@@ -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"

View File

@@ -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``.