From d96ba591976f732b4112da6f0a5c0587d6afd090 Mon Sep 17 00:00:00 2001
From: Chris Hennick <4961925+Pr0methean@users.noreply.github.com>
Date: Mon, 13 May 2024 20:56:03 -0700
Subject: [PATCH] doc: Document symlink extraction behavior

---
 src/read.rs | 4 ++++
 1 file changed, 4 insertions(+)

diff --git a/src/read.rs b/src/read.rs
index 1b505369..f736c066 100644
--- a/src/read.rs
+++ b/src/read.rs
@@ -664,6 +664,10 @@ impl<R: Read + Seek> ZipArchive<R> {
     /// may be left on disk. However, on Unix targets, no newly-created directories with part but
     /// not all of their contents extracted will be readable, writable or usable as process working
     /// directories by any non-root user except you.
+    ///
+    /// On Unix and Windows, symbolic links are extracted correctly. On other platforms such as
+    /// WebAssembly, symbolic links aren't supported, so they're extracted as normal files
+    /// containing the target path in UTF-8.
     pub fn extract<P: AsRef<Path>>(&mut self, directory: P) -> ZipResult<()> {
         use std::fs;
         #[cfg(unix)]