Browse Source

Merge pull request #90766 from AThousandShips/file_doc

[Doc] Clarify behavior of `FileAccess.get_line`
Rémi Verschelde 1 year ago
parent
commit
ec2e394d04
1 changed files with 1 additions and 1 deletions
  1. 1 1
      doc/classes/FileAccess.xml

+ 1 - 1
doc/classes/FileAccess.xml

@@ -190,7 +190,7 @@
 		<method name="get_line" qualifiers="const">
 			<return type="String" />
 			<description>
-				Returns the next line of the file as a [String].
+				Returns the next line of the file as a [String]. The returned string doesn't include newline ([code]\n[/code]) or carriage return ([code]\r[/code]) characters, but does include any other leading or trailing whitespace.
 				Text is interpreted as being UTF-8 encoded.
 			</description>
 		</method>