You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
When generating the documentation of a Puppet function, puppet-strings wants to see a @return tag in the comments, while the code already include the returned type.
Expected Behavior
puppet-strings should not want a @return tag.
Steps to Reproduce
Generate the documentation of a function (example taken from stdlib):
# @summary function to cast ensure parameter to resource specific value
function stdlib::ensure(
Variant[Boolean, Enum['present', 'absent']] $ensure,
Enum['directory', 'link', 'mounted', 'service', 'file', 'package'] $resource,
) >> String {
# [...]
}
Note the >> String that tells what the function returns.