summaryrefslogtreecommitdiff
path: root/wasp/apps/settings.py
diff options
context:
space:
mode:
authorDaniel Thompson <daniel@redfelineninja.org.uk>2021-01-13 21:51:17 (GMT)
committerDaniel Thompson <daniel@redfelineninja.org.uk>2021-01-13 21:51:17 (GMT)
commit39d87830558540fefad1d4dd24a14f273bd4d5a7 (patch)
tree3a313419861c91ce19b47f9c6e865b55af160077 /wasp/apps/settings.py
parentf7ef1654339b05989f0cdfc9ff5ab78ca03300b6 (diff)
simulator: test_qa: Add some basic docstring tests
This one picked up a lot of inconsistancy so the changes here are pretty big. Signed-off-by: Daniel Thompson <daniel@redfelineninja.org.uk>
Diffstat (limited to 'wasp/apps/settings.py')
-rw-r--r--wasp/apps/settings.py28
1 files changed, 19 insertions, 9 deletions
diff --git a/wasp/apps/settings.py b/wasp/apps/settings.py
index c11c971..c4708e2 100644
--- a/wasp/apps/settings.py
+++ b/wasp/apps/settings.py
@@ -1,20 +1,30 @@
# SPDX-License-Identifier: LGPL-3.0-or-later
# Copyright (C) 2020-21 Daniel Thompson
+"""Settings application
+~~~~~~~~~~~~~~~~~~~~~~~
+
+Allows a very small set of user preferences (including the date and
+time) to be set on the device itself.
+
+.. figure:: res/SettingsApp.png
+ :width: 179
+
+.. note::
+
+ The settings tool is not expected to comprehensively present every
+ user configurable preference. Some are better presented via a
+ companion app and some particular exotic ones are perhaps best
+ managed with a user-provided ``main.py``.
+"""
+
+
import wasp
import fonts
import icons
class SettingsApp():
- """Ultra-simple settings application.
-
- Currently the settings application contains only one setting: brightness
-
- .. figure:: res/SettingsApp.png
- :width: 179
-
- Screenshot of the settings application
- """
+ """Settings application."""
NAME = 'Settings'
ICON = icons.settings