Puppet Strings Module Release

17 views
Skip to first unread message

Ian Kronquist

unread,
Sep 23, 2015, 4:34:01 PM9/23/15
to puppet...@googlegroups.com
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.


*  The module can be found on the Forge here: https://forge.puppetlabs.com/puppetlabs/strings

*  Installation and usage instructions can be found here: https://github.com/puppetlabs/puppetlabs-strings/blob/master/README.md

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

Reply all
Reply to author
Forward
0 new messages