Flesh out the Prune event docs

This commit is contained in:
Dave Pearson
2022-11-10 19:57:08 +00:00
parent 736237be58
commit de275d7011

View File

@@ -128,7 +128,12 @@ class Unmount(Mount, bubble=False, verbose=False):
class Prune(Event, bubble=False):
"""Sent to the app to ask it to prune one or more widgets from the DOM."""
"""Sent to the app to ask it to prune one or more widgets from the DOM.
Attributes:
widgets (list[Widgets]): The list of widgets to prune.
finished_flag (asyncio.Event): An asyncio Event to that will be flagged when the prune is done.
"""
def __init__(
self, sender: MessageTarget, widgets: list[Widget], finished_flag: asyncio.Event