docstring for archives.update_all

numbbo · Apr 23, 2022 · 5ff3ff3 · 5ff3ff3
1 parent ad640d6
commit 5ff3ff3
Showing 1 changed file with 6 additions and 0 deletions.
diff --git a/code-postprocessing/cocopp/archiving.py b/code-postprocessing/cocopp/archiving.py
@@ -1374,6 +1374,12 @@ def class_(self, name):
         return self._get(name, 1) or COCODataArchive
 
     def update_all(self):
+        """update archive definition files from their remote location.
+
+        The update is necessary to account for newly added data. This
+        method requires www connectivity with only a few KB of transmitted
+        data.
+        """
         # self.set_as_attributes_in(update=True)
         for name in self.names:
             name = name.replace('-', '_')