summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorJosh Smith <joshsmith@ct-lt-766.unassigned>2018-07-18 17:53:38 +0100
committerTristan Van Berkom <tristan.van.berkom@gmail.com>2018-07-19 12:52:21 +0000
commit1016dcb43db19f326dd44c788433419cc86c3031 (patch)
tree49c5db7922e25d079e5bee5c1ab1c7521a24d83b
parent48f66a3ca1c71dccfc30dd9ed818be22ac455bba (diff)
downloadbuildstream-Qinusty/scheduler_docstring_fix.tar.gz
scheduler.py: Correct some anomalies within the docstringsQinusty/scheduler_docstring_fix
-rw-r--r--buildstream/_scheduler/scheduler.py6
1 files changed, 4 insertions, 2 deletions
diff --git a/buildstream/_scheduler/scheduler.py b/buildstream/_scheduler/scheduler.py
index 5783e5a67..3d1d79b61 100644
--- a/buildstream/_scheduler/scheduler.py
+++ b/buildstream/_scheduler/scheduler.py
@@ -43,7 +43,7 @@ class SchedStatus():
# The scheduler operates on a list queues, each of which is meant to accomplish
# a specific task. Elements enter the first queue when Scheduler.run() is called
# and into the next queue when complete. Scheduler.run() returns when all of the
-# elements have been traversed or when an occurs.
+# elements have been traversed or when an error occurs.
#
# Using the scheduler is a matter of:
# a.) Deriving the Queue class and implementing its abstract methods
@@ -104,6 +104,8 @@ class Scheduler():
# queues (list): A list of Queue objects
#
# Returns:
+ # (timedelta): The amount of time since the start of the session,
+ # discounting any time spent while jobs were suspended
# (SchedStatus): How the scheduling terminated
#
# Elements in the 'plan' will be processed by each
@@ -199,7 +201,7 @@ class Scheduler():
# Fetches the current session elapsed time
#
# Returns:
- # (datetime): The amount of time since the start of the session,
+ # (timedelta): The amount of time since the start of the session,
# discounting any time spent while jobs were suspended.
#
def elapsed_time(self):