summaryrefslogtreecommitdiff
path: root/doc/classes
diff options
context:
space:
mode:
authorRyan Roden-Corrent <ryan@rcorre.net>2020-09-30 19:04:26 -0400
committerRyan Roden-Corrent <ryan@rcorre.net>2020-10-01 07:03:24 -0400
commit2762821c08ef011dd44381fd55b6569f99bad41b (patch)
tree71133ec21304427e4a873d14271b71f06ecc4799 /doc/classes
parent4a4be06260085d7aad8c7082d6d59a14fcc279e8 (diff)
Clarify store_string vs store_line.
While the behavior can be implied from the name, it seems worth stating it explicitly.
Diffstat (limited to 'doc/classes')
-rw-r--r--doc/classes/File.xml6
1 files changed, 2 insertions, 4 deletions
diff --git a/doc/classes/File.xml b/doc/classes/File.xml
index f1b9106d35..9a94231cc1 100644
--- a/doc/classes/File.xml
+++ b/doc/classes/File.xml
@@ -399,8 +399,7 @@
<argument index="0" name="line" type="String">
</argument>
<description>
- Stores the given [String] as a line in the file.
- Text will be encoded as UTF-8.
+ Appends [code]line[/code] to the file followed by a line return character ([code]\n[/code]), encoding the text as UTF-8.
</description>
</method>
<method name="store_pascal_string">
@@ -428,8 +427,7 @@
<argument index="0" name="string" type="String">
</argument>
<description>
- Stores the given [String] in the file.
- Text will be encoded as UTF-8.
+ Appends [code]string[/code] to the file without a line return, encoding the text as UTF-8.
</description>
</method>
<method name="store_var">