Announce: puppet-strings 1.1.0 Released

[Will Hopper]

Hello, all! Today we're releasing puppet-strings 1.1.0. This is a small release that includes two features: the new `summary` tag, and the ability to explicitly document the types of parameters in Puppet 4 code.

Features:

• The `summary` tag can be added to any code that puppet-strings supports. The recommended length limit for a summary is 140 characters. Warnings will be issued for strings longer than this limit. (See https://tickets.puppetlabs.com/browse/PDOC-161 and https://github.com/puppetlabs/puppet-strings#documenting-puppet-classes-and-defined-types).
• Puppet 4 parameter types can now be (optionally) explicitly documented. Previously, this was not allowed because Puppet 4 parameter types are automatically determined without extra documentation. However, users may desire to do so anyway for consistency. Strings will emit a warning if the documented type does not match the actual type. In such an event, the incorrect documented type will be ignored in favor of the real one. Note that this is purely optional - Strings will continue to automatically determine the types of Puppet 4 parameters without this documentation.

New to Strings? Check out our recent blog post to learn more! https://puppet.com/blog/using-puppet-strings-generate-great-documentation-puppet-modules.

The ruby gem can be found here: https://rubygems.org/gems/puppet-strings.

For installation and usage instructions, see https://github.com/puppetlabs/puppet-strings/blob/master/README.md.

To track issues related to this release or report issues, see the PDOC Jira project:

JIRA Project: https://tickets.puppetlabs.com/browse/PDOC

Fixed in 1.1.0: https://tickets.puppetlabs.com/issues/?filter=25603

Introduced in 1.1.0: https://tickets.puppetlabs.com/issues/?filter=25604

--

William Hopper

Software Engineer