5011: Make docstring less scary.
authorTom Clegg <tom@curoverse.com>
Fri, 6 Feb 2015 18:42:00 +0000 (13:42 -0500)
committerTom Clegg <tom@curoverse.com>
Fri, 6 Feb 2015 18:42:00 +0000 (13:42 -0500)
sdk/python/arvados/collection.py

index 18e9e63da6af5822b2e62e1fa1138724a6df7d68..7bfdf782f8d06b03d6ac482fa64872d1eb8ff9be 100644 (file)
@@ -560,11 +560,12 @@ class CollectionWriter(CollectionBase):
     def finish(self):
         """Store the manifest in Keep and return its locator.
 
-        Beware, this is only useful in special cases like storing
-        manifest fragments temporarily in Keep during a Crunch job. In
-        most cases you should make a collection instead, by sending
-        manifest_text() to the API server's "create collection"
-        endpoint.
+        This is useful for storing manifest fragments (task outputs)
+        temporarily in Keep during a Crunch job.
+
+        In other cases you should make a collection instead, by
+        sending manifest_text() to the API server's "create
+        collection" endpoint.
         """
         return self._my_keep().put(self.manifest_text(), copies=self.replication)