From f53cc041dcdf2b40b029563db554fe9e4eb5c066 Mon Sep 17 00:00:00 2001 From: Russell Keith-Magee Date: Mon, 20 Nov 2023 11:26:14 +0800 Subject: [PATCH] Correct documentation errors. --- docs/reference/api/resources/command.rst | 6 ++++-- docs/reference/api/windowlessapp.rst | 6 +++--- docs/spelling_wordlist | 1 + 3 files changed, 8 insertions(+), 5 deletions(-) diff --git a/docs/reference/api/resources/command.rst b/docs/reference/api/resources/command.rst index 15abf9e279..3eb33edae0 100644 --- a/docs/reference/api/resources/command.rst +++ b/docs/reference/api/resources/command.rst @@ -73,6 +73,8 @@ It isn't possible to have functionality exposed on a toolbar that isn't also exp the app. So, ``cmd2`` will be added to the app, even though it wasn't explicitly added to the app commands. +.. _status-item-group: + Status Item Groups ~~~~~~~~~~~~~~~~~~ @@ -102,8 +104,8 @@ Notes installed by default for most users. Toga has no way to detect if the user's environment supports status indicators, so there is not guarantee that any status indicators provided by your app will be visible. If your app is using a status item as - the only user interface (e.g., in a :ref:`Windowless app - `__), this may result in an app that appears to do + the only user interface (e.g., in a :doc:`Windowless app + `), this may result in an app that appears to do nothing, but raises no errors. Reference diff --git a/docs/reference/api/windowlessapp.rst b/docs/reference/api/windowlessapp.rst index ba1bcd5a30..efc9cd8059 100644 --- a/docs/reference/api/windowlessapp.rst +++ b/docs/reference/api/windowlessapp.rst @@ -15,9 +15,9 @@ Usage ----- A WindowlessApp is a specialized subclass of App that is used for apps that *don't* have -a main window, such as an app that generates a icon in the system tray or status bar. -As there is no main window controlling the app, the app is responsible for defining the -user action that will exit the app. +a main window, such as an app that generates a :ref:`icon in the system tray or status +bar `. As there is no main window controlling the app, the app is +responsible for defining the user action that will exit the app. Reference --------- diff --git a/docs/spelling_wordlist b/docs/spelling_wordlist index 293ed0cb6f..11598d23ea 100644 --- a/docs/spelling_wordlist +++ b/docs/spelling_wordlist @@ -4,6 +4,7 @@ amongst App apps awaitable +Ayatana backend backends BeeWare