We’re excited to announce
the latest release of the Strings module! Strings generates HTML
documentation from inline comments and is designed to replace puppet doc.
Strings 0.3.1 is a backward-compatible minor release. It includes
support for generating documentation from Types and Providers,
extracting and checking type signatures from Puppet 4.0 functions and
classes, and checking that documented parameter names and types match
what's actually in the code. Inline comments are the future for
documenting Puppet modules, so if you maintain a module go ahead and
take Strings for a spin and let us know what you think! This release was
driven by Ian Kronquist’s Summer intern project.
To track issues related to this release or file new issues, head over to the PDOC JIRA Project:
Ian Kronquist
Software Developer, OSU Open Source Lab