Expand docs and tests for overlay.

jaraco · Aug 29, 2024 · 68991bf · 68991bf
1 parent c23e549
commit 68991bf
Showing 1 changed file with 12 additions and 1 deletion.
diff --git a/zipp/compat/overlay.py b/zipp/compat/overlay.py
@@ -1,5 +1,16 @@
 """
-Expose zipp.Path as .zipfile.Path
+Expose zipp.Path as .zipfile.Path.
+
+Includes everything else in ``zipfile`` to match future usage. Just
+use:
+
+>>> from zipp.compat.overlay import zipfile
+
+in place of ``import zipfile``.
+
+Relative imports are supported too.
+
+>>> from zipp.compat.overlay.zipfile import ZipInfo
 """
 
 import importlib