From 95e74a4e9cffefce4ca6107851aed84e265b0792 Mon Sep 17 00:00:00 2001 From: Piero Toffanin Date: Fri, 7 Dec 2018 16:13:33 -0500 Subject: [PATCH] Updated docs --- app/migrations/0022_auto_20181205_1644.py | 4 ++-- app/migrations/0023_task_running_progress.py | 2 +- app/models/task.py | 6 +++--- slate/source/includes/reference/_task.md | 19 +++++++++++++------ 4 files changed, 19 insertions(+), 12 deletions(-) diff --git a/app/migrations/0022_auto_20181205_1644.py b/app/migrations/0022_auto_20181205_1644.py index f25adc24..37a68b8d 100644 --- a/app/migrations/0022_auto_20181205_1644.py +++ b/app/migrations/0022_auto_20181205_1644.py @@ -17,11 +17,11 @@ class Migration(migrations.Migration): migrations.AddField( model_name='task', name='resize_progress', - field=models.FloatField(blank=True, default=0.0, help_text="Value between 0 and 1 indicating the resize progress of this task's images."), + field=models.FloatField(blank=True, default=0.0, help_text="Value between 0 and 1 indicating the resize progress of this task's images"), ), migrations.AddField( model_name='task', name='upload_progress', - field=models.FloatField(blank=True, default=0.0, help_text="Value between 0 and 1 indicating the upload progress of this task's files to the processing node."), + field=models.FloatField(blank=True, default=0.0, help_text="Value between 0 and 1 indicating the upload progress of this task's files to the processing node"), ), ] diff --git a/app/migrations/0023_task_running_progress.py b/app/migrations/0023_task_running_progress.py index 68e2b2c2..e615b8a7 100644 --- a/app/migrations/0023_task_running_progress.py +++ b/app/migrations/0023_task_running_progress.py @@ -13,6 +13,6 @@ class Migration(migrations.Migration): migrations.AddField( model_name='task', name='running_progress', - field=models.FloatField(blank=True, default=0.0, help_text="Value between 0 and 1 indicating the running progress (estimated) of this task's."), + field=models.FloatField(blank=True, default=0.0, help_text="Value between 0 and 1 indicating the running progress (estimated) of this task"), ), ] diff --git a/app/models/task.py b/app/models/task.py index cd78d596..f185549c 100644 --- a/app/models/task.py +++ b/app/models/task.py @@ -198,13 +198,13 @@ class Task(models.Model): resize_to = models.IntegerField(default=-1, help_text="When set to a value different than -1, indicates that the images for this task have been / will be resized to the size specified here before processing.") upload_progress = models.FloatField(default=0.0, - help_text="Value between 0 and 1 indicating the upload progress of this task's files to the processing node.", + help_text="Value between 0 and 1 indicating the upload progress of this task's files to the processing node", blank=True) resize_progress = models.FloatField(default=0.0, - help_text="Value between 0 and 1 indicating the resize progress of this task's images.", + help_text="Value between 0 and 1 indicating the resize progress of this task's images", blank=True) running_progress = models.FloatField(default=0.0, - help_text="Value between 0 and 1 indicating the running progress (estimated) of this task's.", + help_text="Value between 0 and 1 indicating the running progress (estimated) of this task", blank=True) def __init__(self, *args, **kwargs): diff --git a/slate/source/includes/reference/_task.md b/slate/source/includes/reference/_task.md index e0370522..e6537167 100644 --- a/slate/source/includes/reference/_task.md +++ b/slate/source/includes/reference/_task.md @@ -31,9 +31,11 @@ "value": true } ], - "ground_control_points": null, "created_at": "2017-02-18T18:01:55.402551Z", - "pending_action": null + "pending_action": null, + "upload_progress": 1.0, + "resize_progress": 0.0, + "running_progress": 1.0 } ``` @@ -55,9 +57,12 @@ auto_processing_node | boolean | Whether WebODM should automatically assign the status | int | One of [Status Codes](#status-codes), or `null` if no status is available. last_error | string | The last error message reported by a [Processing Node](#processing-node) in case of processing failure. options | JSON[] | JSON-encoded list of name/value pairs, where each pair represents a command line option to be passed to a [Processing Node](#processing-node). -ground_control_points | string | Currently unused. See [#37](https://github.com/OpenDroneMap/WebODM/issues/37) -created_at | string | Creation date and time +created_at | string | Creation date and time. pending_action | int | One of [Pending Actions](#pending-actions), or `null` if no pending action is set. +upload_progress | float | Value between 0 and 1 indicating the upload progress of this task's files to the processing node. +resize_progress | float | Value between 0 and 1 indicating the resize progress of this task's images. +running_progress | float | Value between 0 and 1 indicating the running progress (estimated) of this task. + @@ -102,9 +107,11 @@ Parameters are the same as above. "status": 40, "last_error": null, "options": [], - "ground_control_points": null, "created_at": "2016-12-08T13:32:28.139474Z", - "pending_action": null + "pending_action": null, + "upload_progress": 1.0, + "resize_progress": 0.0, + "running_progress": 1.0 } ] ```