[kupfer] task: Docstring for StepTask



commit 4827c63865f563b9491109c5e0794c518de32847
Author: Ulrik Sverdrup <ulrik sverdrup gmail com>
Date:   Sun Aug 23 21:51:15 2009 +0200

    task: Docstring for StepTask

 kupfer/task.py |    4 ++++
 1 files changed, 4 insertions(+), 0 deletions(-)
---
diff --git a/kupfer/task.py b/kupfer/task.py
index 4b3ef75..d19c82e 100644
--- a/kupfer/task.py
+++ b/kupfer/task.py
@@ -22,6 +22,10 @@ class StepTask (Task):
 	be called regardless of exit or failure mode
 	"""
 	def step(self):
+		"""Do a small part of the task.
+		Return True to continue processing,
+		or a False value to finish.
+		"""
 		pass
 	def finish(self):
 		pass



[Date Prev][Date Next]   [Thread Prev][Thread Next]   [Thread Index] [Date Index] [Author Index]