Properly document jira::sorted_hash as private

oranenj · ekohl · web-flow · commit 8fb3de889e4c · 2021-04-15T18:09:04.000+03:00
Co-authored-by: Ewoud Kohl van Wijngaarden &lt;ewoud@kohlvanwijngaarden.nl&gt;
diff --git a/functions/sort_hash.pp b/functions/sort_hash.pp
@@ -1,4 +1,6 @@
-function jira::sort_hash(Hash $input) {
+# @summary Return a sorted hash
+# @api private
+function jira::sort_hash(Hash $input) >> Hash {
   # Puppet hashes are "insertion order", so this works to sort by key
   Hash(sort(Array($input)))
 }

Original file line number	Diff line number	Diff line change
`@@ -1,4 +1,6 @@`
`1`		`-function jira::sort_hash(Hash $input) {`
	`1`	`+# @summary Return a sorted hash`
	`2`	`+# @api private`
	`3`	`+function jira::sort_hash(Hash $input) >> Hash {`
`2`	`4`	`# Puppet hashes are "insertion order", so this works to sort by key`
`3`	`5`	`Hash(sort(Array($input)))`
`4`	`6`	`}`