summaryrefslogtreecommitdiff
path: root/wasp/wasp.py
diff options
context:
space:
mode:
authorDaniel Thompson <daniel@redfelineninja.org.uk>2020-05-14 21:29:35 (GMT)
committerDaniel Thompson <daniel@redfelineninja.org.uk>2020-05-14 21:29:35 (GMT)
commitb8efcd30537f04269738e6969376129f4ed88315 (patch)
treecf0f4f2d12603ca85bc5f0b664bcd4883b85f436 /wasp/wasp.py
parentf07fb6d22a7124f945a29c2895cec87a69e08b37 (diff)
wasp: Even more docstrings
Diffstat (limited to 'wasp/wasp.py')
-rw-r--r--wasp/wasp.py15
1 files changed, 11 insertions, 4 deletions
diff --git a/wasp/wasp.py b/wasp/wasp.py
index a92ceed..f8648e4 100644
--- a/wasp/wasp.py
+++ b/wasp/wasp.py
@@ -1,11 +1,18 @@
# SPDX-License-Identifier: LGPL-3.0-or-later
# Copyright (C) 2020 Daniel Thompson
-"""WASP system management (including constants)
+"""Wasp-os system manager
+~~~~~~~~~~~~~~~~~~~~~~~~~
-.. data:: system = Manager()
+.. data:: wasp.system
- system is the system-wide instance of the Manager class. Applications
- can use this instance to access system services.
+ wasp.system is the system-wide singleton instance of :py:class:`.Manager`.
+ Application must use this instance to access the system services provided
+ by the manager.
+
+.. data:: wasp.watch
+
+ wasp.watch is an import of :py:mod:`watch` and is simply provided as a
+ shortcut (and to reduce memory by keeping it out of other namespaces).
"""
import gc