Comment differences between Maven/Versioned

audeering · May 3, 2024 · 1f972eb · 1f972eb
1 parent 0e83b5a
commit 1f972eb
Showing 1 changed file with 18 additions and 1 deletion.
diff --git a/audb/core/repository.py b/audb/core/repository.py
@@ -61,9 +61,26 @@ def __call__(self) -> typing.Type[audbackend.interface.Base]:
         backend_class = self.backend_registry[self.backend]
         backend = backend_class(self.host, self.name)
         if self.backend == "artifactory":
-            # Maven version file structure on Artifactory
+            # Maven version file structure on Artifactory,
+            # e.g. for version 1.0.0 of emodb
+            #
+            # emodb/db/1.0.0/db-1.0.0.yaml   <-- header
+            # emodb/db/1.0.0/db-1.0.0.zip    <-- dependency table
+            # emodb/attachment/.../1.0.0/... <-- attachments
+            # emodb/media/.../1.0.0/...      <-- media files
+            # emodb/meta/.../1.0.0/...       <-- tables
+            #
             interface = audbackend.interface.Maven(backend)
         else:
+            # Simpler version file structure on all other backends,
+            # e.g. for version 1.0.0 of emodb
+            #
+            # emodb/1.0.0/db.yaml            <-- header
+            # emodb/1.0.0/db.zip             <-- dependency table
+            # emodb/attachment/1.0.0/...     <-- attachments
+            # emodb/media/1.0.0/...          <-- media files
+            # emodb/meta/1.0.0/...           <-- tables
+            #
             interface = audbackend.interface.Versioned(backend)
         return interface