Adds docs about using ProgressBar with threads

closes #2318 https://pulp.plan.io/issues/2318
pulp · Dec 4, 2016 · d281930 · d281930
1 parent 950bb58
commit d281930
Showing 1 changed file with 4 additions and 0 deletions.
diff --git a/app/pulp/app/models/progress.py b/app/pulp/app/models/progress.py
@@ -181,6 +181,10 @@ class ProgressBar(ProgressReport):
 
     ProgressBar objects are associated with a Task and auto-discover and populate the task id when
     saved.
+
+    Plugin writers should use a single instance of a ProgressBar when using threads to perform work
+    in parallel. Each thread should use the same ProgressBar instance when calling increment() or
+    using the iter() convenience method.
     """
 
     class Meta: