Open
Description
Describe the Bug
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.
Environment
- Version : 2.9.0
- Platform : Any
Additional Context
Suggested by @ekohl in puppetlabs/puppetlabs-stdlib#1239 (comment)