add deprecation warning to doc string

onflow · Oct 30, 2023 · 860f296 · 860f296
1 parent 10aafc5
commit 860f296
Showing 1 changed file with 9 additions and 1 deletion.
diff --git a/runtime/stdlib/random.go b/runtime/stdlib/random.go
@@ -71,7 +71,15 @@ func NewRevertibleRandomFunction(generator RandomGenerator) StandardLibraryValue
 
 // `unsafeRandom` related constants and functions will be deleted
 // when the function is deprecated
-const unsafeRandomFunctionDocString = revertibleRandomFunctionDocString
+const unsafeRandomFunctionDocString = `
+Warning: this function will be deprecated, use revertibleRandom function instead. 
+
+Returns a pseudo-random number.
+
+NOTE: The use of this function is unsafe if not used correctly.
+
+Follow best practices to prevent security issues when using this function
+`
 
 var unsafeRandomFunctionType = revertibleRandomFunctionType