Improve docstrings for sphinx.

[python_utils.git] / waitable_presence.py

diff --git a/waitable_presence.py b/waitable_presence.py
index 9247a67891307fb9b93e5695df68347577f86c9b..9d79c6c5d61e1065f1444670c3ce24c1b9b7cd0f 100644 (file)
--- a/waitable_presence.py
+++ b/waitable_presence.py
@@ -1,9 +1,10 @@
 #!/usr/bin/env python3
 
+# © Copyright 2021-2022, Scott Gasch
+
 """A PresenceDetector that is waitable.  This is not part of
 base_presence.py because I do not want to bring these dependencies
 into that lower-level module (especially state_tracker).
-
 """
 
 import datetime
@@ -24,7 +25,7 @@ class WaitablePresenceDetectorWithMemory(state_tracker.WaitableAutomaticStateTra
     """
     This is a waitable class that keeps a PresenceDetector internally
     and periodically polls it to detect changes in presence in a
-    particular location.  Example suggested usage pattern:
+    particular location.  Example suggested usage pattern::
 
         detector = waitable_presence.WaitablePresenceDetectorWithMemory(60.0)
         while True: