Added a note to documentation

haukex · Jun 28, 2024 · 81d1095 · 81d1095
1 parent 32b4737
commit 81d1095
Show file tree

Hide file tree

Showing 2 changed files with 12 additions and 0 deletions.
diff --git a/README.md b/README.md
@@ -61,6 +61,12 @@ For example, to read all CSV files in the current directory and below, including
 - [tarfile Issues](https://github.com/orgs/python/projects/11)
 - [gzip Issues](https://github.com/orgs/python/projects/20/views/2)
 
+#### NOTE
+The original name of a gzip-compressed file is derived from the compressed file’s name
+by simply removing the `.gz` extension. Using the original filename from the gzip
+file’s header is currently not possible due to
+[limitations in the underlying library](https://github.com/python/cpython/issues/71638).
+
 ## API
 
 <a id="function-unzipwalk"></a>

diff --git a/unzipwalk/__init__.py b/unzipwalk/__init__.py
@@ -58,6 +58,12 @@
     - `tarfile Issues <https://github.com/orgs/python/projects/11>`_
     - `gzip Issues <https://github.com/orgs/python/projects/20/views/2>`_
 
+.. note::
+    The original name of a gzip-compressed file is derived from the compressed file's name
+    by simply removing the ``.gz`` extension. Using the original filename from the gzip
+    file's header is currently not possible due to
+    `limitations in the underlying library <https://github.com/python/cpython/issues/71638>`_.
+
 API
 ---