From 53e70e8f5af402e0615c2f953ad0454ef4d9adef Mon Sep 17 00:00:00 2001 From: Joshua Harlow Date: Fri, 24 Jun 2016 18:29:02 -0700 Subject: [PATCH] Add basic docstrings to stopwatch has_started/stopped methods This will ensure these methods get pulled into sphinx when the docs are built for this object (so that people will know that these methods exist and can be used). Change-Id: I4e890a4830a976b4ea5fb8d5b57b03c20411df03 --- oslo_utils/timeutils.py | 2 ++ 1 file changed, 2 insertions(+) diff --git a/oslo_utils/timeutils.py b/oslo_utils/timeutils.py index a7d87533..d2cfc503 100644 --- a/oslo_utils/timeutils.py +++ b/oslo_utils/timeutils.py @@ -534,9 +534,11 @@ class StopWatch(object): return self.elapsed() > self._duration def has_started(self): + """Returns True if the watch is in a started state.""" return self._state == self._STARTED def has_stopped(self): + """Returns True if the watch is in a stopped state.""" return self._state == self._STOPPED def resume(self):