From 5f098d6db6da62deb77d6d555ab67d6cb15f80c2 Mon Sep 17 00:00:00 2001
From: Hugo Locurcio <hugo.locurcio@hugo.pro>
Date: Thu, 29 Apr 2021 00:47:16 +0200
Subject: Document that `File.open_compressed()` can only open files saved by
 Godot

---
 doc/classes/File.xml | 1 +
 1 file changed, 1 insertion(+)

(limited to 'doc')

diff --git a/doc/classes/File.xml b/doc/classes/File.xml
index e0781e807f..f0b9156b89 100644
--- a/doc/classes/File.xml
+++ b/doc/classes/File.xml
@@ -275,6 +275,7 @@
 			</argument>
 			<description>
 				Opens a compressed file for reading or writing.
+				[b]Note:[/b] [method open_compressed] can only read files that were saved by Godot, not third-party compression formats. See [url=https://github.com/godotengine/godot/issues/28999]GitHub issue #28999[/url] for a workaround.
 			</description>
 		</method>
 		<method name="open_encrypted">
-- 
cgit v1.2.3