Start documenting module archive.archive

RKrahl · Mar 18, 2024 · c218c9e · c218c9e
1 parent 199a81d
commit c218c9e
Show file tree

Hide file tree

Showing 2 changed files with 26 additions and 2 deletions.
diff --git a/doc/src/mod-archive.rst b/doc/src/mod-archive.rst
@@ -1,5 +1,26 @@
 :mod:`archive.archive` --- Provide the Archive class
 ====================================================
 
-.. automodule:: archive.archive
-   :members:
+.. py:module:: archive.archive
+
+.. autoclass:: archive.archive.DedupMode
+    :members:
+    :show-inheritance:
+
+    .. attribute:: NEVER
+
+       never use hard links in the archive
+
+    .. attribute:: LINK
+
+       when already the input files were hard linked to each other in
+       the file system
+
+    .. attribute:: CONTENT
+
+       when the input files have the same content
+
+.. autoclass:: archive.archive.Archive
+    :members:
+    :undoc-members:
+    :show-inheritance:
diff --git a/src/archive/archive.py b/src/archive/archive.py
@@ -26,6 +26,9 @@ def _is_normalized(p):
         return False
 
 class DedupMode(Enum):
+    """De-duplication mode when creating an archive: when to use hard
+    links in the archive.
+    """
     NEVER = 'never'
     LINK = 'link'
     CONTENT = 'content'