Browse Source

Merge pull request #76018 from AThousandShips/image_doc

Fix `Image.compress` description
Rémi Verschelde 2 years ago
parent
commit
4dcf2c5431
1 changed files with 1 additions and 1 deletions
  1. 1 1
      doc/classes/Image.xml

+ 1 - 1
doc/classes/Image.xml

@@ -78,7 +78,7 @@
 			<param index="2" name="astc_format" type="int" enum="Image.ASTCFormat" default="0" />
 			<param index="2" name="astc_format" type="int" enum="Image.ASTCFormat" default="0" />
 			<description>
 			<description>
 				Compresses the image to use less memory. Can not directly access pixel data while the image is compressed. Returns error if the chosen compression mode is not available.
 				Compresses the image to use less memory. Can not directly access pixel data while the image is compressed. Returns error if the chosen compression mode is not available.
-				The [param mode] parameter helps to pick the best compression method for DXT and ETC2 formats. It is ignored for ASTC compression.
+				The [param source] parameter helps to pick the best compression method for DXT and ETC2 formats. It is ignored for ASTC compression.
 				For ASTC compression, the [param astc_format] parameter must be supplied.
 				For ASTC compression, the [param astc_format] parameter must be supplied.
 			</description>
 			</description>
 		</method>
 		</method>