From 8999ca5a3d67f7d7feb3a39d62c29ec3d3d1f465 Mon Sep 17 00:00:00 2001 From: Will McGugan Date: Thu, 28 Apr 2022 13:19:17 +0100 Subject: [PATCH] docstring --- src/textual/app.py | 5 +++++ src/textual/message_pump.py | 1 + 2 files changed, 6 insertions(+) diff --git a/src/textual/app.py b/src/textual/app.py index c7d73963c..c0be02030 100644 --- a/src/textual/app.py +++ b/src/textual/app.py @@ -174,6 +174,11 @@ class App(Generic[ReturnType], DOMNode): dark = Reactive(False) def exit(self, result: ReturnType | None = None) -> None: + """Exit the app, and return the supplied result. + + Args: + result (ReturnType | None, optional): Return value. Defaults to None. + """ self._return_value = result self.close_messages_no_wait() diff --git a/src/textual/message_pump.py b/src/textual/message_pump.py index c426cb2bd..0d9fb0dfb 100644 --- a/src/textual/message_pump.py +++ b/src/textual/message_pump.py @@ -174,6 +174,7 @@ class MessagePump: ) def close_messages_no_wait(self) -> None: + """Request the message queue to exit.""" self._message_queue.put_nowait(MessagePriority(None)) async def close_messages(self) -> None: