better doc for StatefulPublisher.reset_state

semiversus · Oct 6, 2018 · 88e7e67 · 88e7e67
1 parent d39d113
commit 88e7e67
Showing 1 changed file with 5 additions and 2 deletions.
diff --git a/broqer/publisher.py b/broqer/publisher.py
@@ -175,7 +175,10 @@ def notify(self, value: Any) -> asyncio.Future:
         return Publisher.notify(self, value)
 
     def reset_state(self, value=NONE):
-        """ Resets the state. Behavior for .subscribe() and .get() will be
-        like a stateless Publisher until next .emit()
+        """ Resets the state. If value argument is not used, the behavior for
+        .subscribe() and .get() will be like a stateless Publisher until next
+        .emit() . Calling this method will not trigger an emit.
+
+        :param value: Optional value to set the internal state
         """
         self._state = value