Changeset 9661

Timestamp:

17 Nov 2012, 10:43:35 (12 years ago)

Author:

uli

Message:

Update docs to reflect actual data produced. Do we really need a
starttime value?

File:

• main/waeup.kofa/trunk/src/waeup/kofa/reports.py (modified) (6 diffs)

main/waeup.kofa/trunk/src/waeup/kofa/reports.py

@@ -151 +151 @@
 
     def get_report_jobs_description(user_id=None):
-        """Get running/completed report jobs for `user_id` as list of tuples.
+        """Get running/completed report jobs fur `user_id` as list of tuples.
 
         The results contain enough information to render a status page
@@ -157 +157 @@
 
           (``<job_id>, <description>, <status_translated>,
-          <discardable>, <downloadable>``)
+          <discardable>, <downloadable>, <starttime>, <user_name>``)
 
         in that order, with
@@ -178 +178 @@
             downloaded. This is only true if the job finished and
             didn't raised exceptions.
+
+        ``<starttime>``
+            String indicating when the job was started.
+
+        ``<user_name>``
+            Name of user that started the job.
 
         If ``user_id`` is ``None``, all jobs are returned.
@@ -440 +446 @@
 
           (``<job_id>, <description>, <status_translated>,
-          <discardable>, <downloadable>``)
+          <discardable>, <downloadable>, <starttime>, <user_name>``)
 
         in that order, with
@@ -464 +470 @@
         ``<starttime>``
             String indicating when the job was started.
+
+        ``<user_name>``
+            Name of user that started the job.
 
         If ``user_id`` is ``None``, all jobs are returned.
@@ -476 +485 @@
             downloadable = job.finished and not job.failed
             running = not (downloadable or discardable)
+            # XXX: starttime might be better included in description
             starttime = getattr(job, 'begin_after', None)
             if starttime:
+                # XXX is it really neccessary to get a localized time here?
                 starttime = starttime.astimezone(getUtility(IKofaUtils).tzinfo)
                 starttime = starttime.strftime("%Y-%m-%d %H:%M:%S %Z")