Update description of Object.free() method

Clarify that variables pointing to an object don't become `null` when that object is freed, it just makes them invalid. (cherry picked from commit ccf5703568ab7c33723f322088c83a7d9ebcf5a8)

Update description of Object.free() method
55bad664 · Remi Rampin · Rémi Verschelde · d4599fff · 55bad664
Commit 55bad664 authored May 16, 2020 by Remi Rampin Committed by Rémi Verschelde May 18, 2020
Hide whitespace changes
Inline Side-by-side

Showing with 1 addition and 1 deletion

Object.xml doc/classes/Object.xml +1 -1

No files found.
--- a/doc/classes/Object.xml
+++ b/doc/classes/Object.xml
@@ -192,7 +192,7 @@
 			<return type="void">
 			</return>
 			<description>
-				Deletes the object from memory. Any pre-existing reference to the freed object will now return [code]null[/code].
+				Deletes the object from memory. Any pre-existing reference to the freed object will become invalid, e.g. [code]is_instance_valid(object)[/code] will return [code]false[/code].
 			</description>
 		</method>
 		<method name="get" qualifiers="const">