From ee89da129fb437ae7972d6fa48c1ab35c8dc8b65 Mon Sep 17 00:00:00 2001
From: Hugo Locurcio <hugo.locurcio@hugo.pro>
Date: Tue, 2 Feb 2021 21:59:24 +0100
Subject: [PATCH] Improve the `File.endian_swap` documentation

(cherry picked from commit c5f0db45df6002258ee0b3f0158d1069f828455e)
---
 doc/classes/File.xml | 5 +++--
 1 file changed, 3 insertions(+), 2 deletions(-)

diff --git a/doc/classes/File.xml b/doc/classes/File.xml
index 410ed490a1c..edcda1ae787 100644
--- a/doc/classes/File.xml
+++ b/doc/classes/File.xml
@@ -445,8 +445,9 @@
 	</methods>
 	<members>
 		<member name="endian_swap" type="bool" setter="set_endian_swap" getter="get_endian_swap" default="false">
-			If [code]true[/code], the file's endianness is swapped. Use this if you're dealing with files written on big-endian machines.
-			[b]Note:[/b] This is about the file format, not CPU type. This is always reset to [code]false[/code] whenever you open the file.
+			If [code]true[/code], the file is read with big-endian [url=https://en.wikipedia.org/wiki/Endianness]endianness[/url]. If [code]false[/code], the file is read with little-endian endianness. If in doubt, leave this to [code]false[/code] as most files are written with little-endian endianness.
+			[b]Note:[/b] [member endian_swap] is only about the file format, not the CPU type. The CPU endianness doesn't affect the default endianness for files written.
+			[b]Note:[/b] This is always reset to [code]false[/code] whenever you open the file. Therefore, you must set [member endian_swap] [i]after[/i] opening the file, not before.
 		</member>
 	</members>
 	<constants>