improve description of results_dir parameters in lineage

data-workspaces · Jul 4, 2019 · 89a988e · 89a988e
1 parent f6af016
commit 89a988e
Showing 1 changed file with 4 additions and 1 deletion.
diff --git a/dataworkspaces/lineage.py b/dataworkspaces/lineage.py
@@ -322,7 +322,10 @@ class LineageBuilder:
 
     Call :func:`~as_results_step` to indicate that this step is producing results.
     This will cause a ``results.json`` file and a ``lineage.json`` file to be created
-    in the specified directory.
+    in the specified directory. This directory should correspond to either the root
+    directory of a results resource or a subdirectory within the resource. If you have
+    multiple steps of your workflow that produce results, you can create separate
+    subdirectories for each results-producing step.
 
     **Example**