diff options
| author | Rémi Verschelde <remi@verschelde.fr> | 2022-08-01 07:54:20 +0200 |
|---|---|---|
| committer | GitHub <noreply@github.com> | 2022-08-01 07:54:20 +0200 |
| commit | 44f1e540f62faf03e64411e1f52c3cb0a31d2758 (patch) | |
| tree | a041630fa75e65fa16811a72a33ff84a7264a98e /doc | |
| parent | 4d4575d3863663174c862f37f2d56596e8ad469b (diff) | |
| parent | 1418f97c70a5551bdbfeea853cbc479b32ea9e08 (diff) | |
Merge pull request #63733 from akien-mga/file-get_as_text-skip-CR
File: Re-add support to skip CR (`\r`) in `File::get_as_text`
Diffstat (limited to 'doc')
| -rw-r--r-- | doc/classes/File.xml | 5 |
1 files changed, 3 insertions, 2 deletions
diff --git a/doc/classes/File.xml b/doc/classes/File.xml index 0b4a8fa46e..3a2776ff21 100644 --- a/doc/classes/File.xml +++ b/doc/classes/File.xml @@ -115,9 +115,10 @@ </method> <method name="get_as_text" qualifiers="const"> <return type="String" /> + <argument index="0" name="skip_cr" type="bool" default="false" /> <description> - Returns the whole file as a [String]. - Text is interpreted as being UTF-8 encoded. + Returns the whole file as a [String]. Text is interpreted as being UTF-8 encoded. + If [code]skip_cr[/code] is [code]true[/code], carriage return characters ([code]\r[/code], CR) will be ignored when parsing the UTF-8, so that only line feed characters ([code]\n[/code], LF) represent a new line (Unix convention). </description> </method> <method name="get_buffer" qualifiers="const"> |