Puppet Strings Module Release

[Ian Kronquist]

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 CHANGELOG can be found here: https://github.com/puppetlabs/puppetlabs-strings/blob/master/CHANGELOG.md

*  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:

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

* Fixes for 0.3.1: https://tickets.puppetlabs.com/issues/?filter=15532

Ian Kronquist

iankro...@gmail.com

Software Developer, OSU Open Source Lab

[Henrik Lindberg]

On 2015-23-09 22:33, Ian Kronquist wrote:
> 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 CHANGELOG can be found here:
> https://github.com/puppetlabs/puppetlabs-strings/blob/master/CHANGELOG.md
>
> * 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:
>
> * JIRA Project: https://tickets.puppetlabs.com/browse/PDOC
>
> * Fixes for 0.3.1: https://tickets.puppetlabs.com/issues/?filter=15532
>
>
> Ian Kronquist

> iankro...@gmail.com <mailto:iankro...@gmail.com>

> Software Developer, OSU Open Source Lab

Congratulations Ian, and thanks for all the great work on Puppet Strings!

- henrik

>
> --
> You received this message because you are subscribed to the Google
> Groups "Puppet Developers" group.
> To unsubscribe from this group and stop receiving emails from it, send
> an email to puppet-dev+...@googlegroups.com
> <mailto:puppet-dev+...@googlegroups.com>.
> To view this discussion on the web visit
> https://groups.google.com/d/msgid/puppet-dev/CAP9O3dcXYDgBH%3DaUZJKryZ3B%3DyeTW1B634-PyK%2BhwRnGxgr%2B-w%40mail.gmail.com
> <https://groups.google.com/d/msgid/puppet-dev/CAP9O3dcXYDgBH%3DaUZJKryZ3B%3DyeTW1B634-PyK%2BhwRnGxgr%2B-w%40mail.gmail.com?utm_medium=email&utm_source=footer>.
> For more options, visit https://groups.google.com/d/optout.


--

Visit my Blog "Puppet on the Edge"
http://puppet-on-the-edge.blogspot.se/

[Rob Reynolds]

Agreed! 

 

--
You received this message because you are subscribed to the Google
Groups "Puppet Developers" group.
To unsubscribe from this group and stop receiving emails from it, send
an email to puppet-dev+...@googlegroups.com
<mailto:puppet-dev+...@googlegroups.com>.
To view this discussion on the web visit
https://groups.google.com/d/msgid/puppet-dev/CAP9O3dcXYDgBH%3DaUZJKryZ3B%3DyeTW1B634-PyK%2BhwRnGxgr%2B-w%40mail.gmail.com
<https://groups.google.com/d/msgid/puppet-dev/CAP9O3dcXYDgBH%3DaUZJKryZ3B%3DyeTW1B634-PyK%2BhwRnGxgr%2B-w%40mail.gmail.com?utm_medium=email&utm_source=footer>.
For more options, visit https://groups.google.com/d/optout.

--

Visit my Blog "Puppet on the Edge"
http://puppet-on-the-edge.blogspot.se/

--
You received this message because you are subscribed to the Google Groups "Puppet Developers" group.

To unsubscribe from this group and stop receiving emails from it, send an email to puppet-dev+...@googlegroups.com.
To view this discussion on the web visit https://groups.google.com/d/msgid/puppet-dev/mtvcer%24fea%241%40ger.gmane.org.

For more options, visit https://groups.google.com/d/optout.

--

Rob Reynolds

Developer, Puppet Labs

PuppetConf 2015 is right around the corner! Join us October 5-9 in Portland, OR. Register now.

[Daniele Sluijters]

So happy to see continued development on this!