Merge pull request #108 from uktrade/docs/add-information-on-limitations

docs: add limitations
uktrade · Oct 12, 2024 · 0a41897 · 0a41897
2 parents 65cf30d + 5dbb5c2
commit 0a41897
Show file tree

Hide file tree

Showing 5 changed files with 14 additions and 4 deletions.
diff --git a/docs/async-interface.md b/docs/async-interface.md
@@ -1,6 +1,6 @@
 ---
 layout: sub-navigation
-order: 3
+order: 4
 title: Async interface
 ---
 

diff --git a/docs/contributing.md b/docs/contributing.md
@@ -1,6 +1,6 @@
 ---
 layout: sub-navigation
-order: 4
+order: 6
 title: How to contribute
 ---
 

diff --git a/docs/exceptions.md b/docs/exceptions.md
@@ -1,6 +1,6 @@
 ---
 layout: sub-navigation
-order: 4
+order: 5
 title: Exceptions
 ---
 

diff --git a/docs/limitations.md b/docs/limitations.md
@@ -0,0 +1,10 @@
+---
+layout: sub-navigation
+order: 3
+title: Limitations
+---
+
+
+Most ZIP files are stream-unzippable, however for technical reasons some are not. If a file is found to not be stream-unzippable, a NotStreamUnzippable exception will be raised.
+
+The only way to address this is to change how the file is created. All member files in the ZIP must either be stored compressed, or stored without a "data descriptor", or if it has a non-zero length its length must be given in its "local header". Explanations of these terms can be found in the ZIP specification: [APPNOTE](https://support.pkware.com/pkzip/appnote).
diff --git a/docs/publish-a-release.md b/docs/publish-a-release.md
@@ -1,6 +1,6 @@
 ---
 layout: sub-navigation
-order: 6
+order: 7
 title: How to publish a release
 ---