secret(): Use proper puppet-strings anotation

bastelfreak · bastelfreak · commit a8bf6167cbb7 · 2024-07-17T18:28:49.000+02:00
diff --git a/REFERENCE.md b/REFERENCE.md
@@ -143,7 +143,7 @@ This function encrypts a string on the server, and then decrypts it on the agent
 
 #### `node_encrypt::secret(Variant[String, Sensitive[String]] $data)`
 
-This function encrypts a string on the server, and then decrypts it on the agent during catalog application.
+The node_encrypt::secret function.
 
 Returns: `Deferred`
 
diff --git a/functions/secret.pp b/functions/secret.pp
@@ -1,4 +1,4 @@
-# This function encrypts a string on the server, and then decrypts it on the agent during catalog application.
+# @summary This function encrypts a string on the server, and then decrypts it on the agent during catalog application.
 function node_encrypt::secret(Variant[String, Sensitive[String]] $data) >> Deferred {
   Deferred('node_decrypt', [node_encrypt($data)])
 }

Original file line number	Diff line number	Diff line change
`@@ -1,4 +1,4 @@`
`1`		`-# This function encrypts a string on the server, and then decrypts it on the agent during catalog application.`
	`1`	`+# @summary This function encrypts a string on the server, and then decrypts it on the agent during catalog application.`
`2`	`2`	`function node_encrypt::secret(Variant[String, Sensitive[String]] $data) >> Deferred {`
`3`	`3`	`Deferred('node_decrypt', [node_encrypt($data)])`
`4`	`4`	`}`