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 ccf5703568)
This commit is contained in:
Remi Rampin 2020-05-16 12:32:41 -04:00 committed by Rémi Verschelde
parent d4599fff68
commit 55bad66447

View file

@ -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">