Add toga.App.app to docs

beeware · Feb 20, 2024 · 3e34b0c · 3e34b0c
1 parent a5782ba
commit 3e34b0c
Show file tree

Hide file tree

Showing 3 changed files with 3 additions and 1 deletion.
diff --git a/changes/2413.doc.rst b/changes/2413.doc.rst
@@ -0,0 +1 @@
+The class property ``toga.App.app`` was added as the currently running app to the reference API for ``App``.
diff --git a/core/src/toga/app.py b/core/src/toga/app.py
@@ -307,6 +307,8 @@ def _default_title(self) -> str:
 
 
 class App:
+    #: The currently running :class:`~toga.App`. Since there can only be one running
+    #: Toga app in a process, this is available as a class property via ``toga.App.app``.
     app = None
 
     def __init__(

diff --git a/docs/reference/api/app.rst b/docs/reference/api/app.rst
@@ -84,7 +84,6 @@ Reference
 ---------
 
 .. autoclass:: toga.App
-    :exclude-members: app
 
 .. autoprotocol:: toga.app.AppStartupMethod
 .. autoprotocol:: toga.app.BackgroundTask
Original file line number	Diff line number	Diff line change
		@@ -0,0 +1 @@
		The class property ``toga.App.app`` was added as the currently running app to the reference API for ``App``.