From 7350f90c579ce6db0be3cf67175778546459322e Mon Sep 17 00:00:00 2001
From: Hugo Locurcio <hugo.locurcio@hugo.pro>
Date: Sun, 9 May 2021 13:23:53 +0200
Subject: [PATCH] Document caveats of `OS.get_unique_id()`

---
 doc/classes/OS.xml | 1 +
 1 file changed, 1 insertion(+)

diff --git a/doc/classes/OS.xml b/doc/classes/OS.xml
index d997073849e..cb95deb9a09 100644
--- a/doc/classes/OS.xml
+++ b/doc/classes/OS.xml
@@ -348,6 +348,7 @@
 			</return>
 			<description>
 				Returns a string that is unique to the device.
+				[b]Note:[/b] This string may change without notice if the user reinstalls/upgrades their operating system or changes their hardware. This means it should generally not be used to encrypt persistent data as the data saved prior to an unexpected ID change would become inaccessible. The returned string may also be falsified using external programs, so do not rely on the string returned by [method get_unique_id] for security purposes.
 				[b]Note:[/b] Returns an empty string on HTML5 and UWP, as this method isn't implemented on those platforms yet.
 			</description>
 		</method>