Flesh out the docstring for DOMQuery.remove

This commit is contained in:
Dave Pearson
2022-11-10 19:49:59 +00:00
parent 1f36ebac97
commit 736237be58

View File

@@ -351,7 +351,11 @@ class DOMQuery(Generic[QueryType]):
return self
def remove(self) -> AwaitRemove:
"""Remove matched nodes from the DOM"""
"""Remove matched nodes from the DOM.
Returns:
AwaitRemove: An awaitable object that waits for the widget to be removed.
"""
prune_finished_event = asyncio.Event()
app = active_app.get()
app.post_message_no_wait(