Hello, all! Today we're happy to announce the release of puppet-strings
1.0.0! For those unfamiliar with the project, Strings is a YARD-based
documentation tool for Puppet extensions that are written in Puppet and
Ruby. Given some simple in-code comments containing YARD tags, it will
generate consistent HTML or JSON documentation for all of your Puppet 3x/4x
API functions, Puppet language functions, Ruby classes, Ruby methods,
types, and providers.
This release includes minor bug fixes based on feedback from the recent
0.99.0 release. We also slightly modified the JSON schema for Puppet
functions (see below).
*Features:*
- The JSON schema for Puppet functions has been altered to include a new
'signatures' top-level key (PDOC-125)
- Includes information about all function signatures (overloads).
Existing overload key format has been preserved
- Reworked README for enhanced clarity (PDOC-133)
*Bug fixes:*
- Fixed an issue where the search box in the code navigator overlapped
list items below it (PDOC-93)
- Strings can now handle multiple `defaultfor` calls in Puppet providers
(PDOC-95)
- Fixed an issue preventing the generated _index.html file from being
uploaded to GitHub pages via the gh_pages task (PDOC-120)
- Fixed several issues with String's handling of Puppet 3.x and 4.x
function return types (PDOC-135), (PDOC-136)
- Fixed an issue where String's didn't properly parse overloads if no
summary description was provided (PDOC-129)
- Strings now correctly handles Puppet 3.x functions when the
`newfunction` call is on a newline (PDOC-122)
- Fixed an issue where certain Ruby string constructs were incompletely
stripped from some docstrings (PDOC-126)
- Hanging indents from type feature descriptions are now properly
stripped (PDOC-127)
Never used Strings? Check out our recent blog post to learn more!
https://puppet.com/blog/using-puppet-strings-generate-great-documentation-puppet-modules
The rubygem 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 for 1.0.0: https://tickets.puppetlabs.com/issues/?filter=23607
- Introduced in 1.0.0: https://tickets.puppetlabs.com/issues/?filter=23606
--
William Hopper
Software Engineer
--
You received this message because you are subscribed to the Google Groups
"Puppet Users" group.
To unsubscribe from this group and stop receiving emails from it, send an email
to puppet-users+unsubscr...@googlegroups.com.
To view this discussion on the web visit
https://groups.google.com/d/msgid/puppet-users/b5ecca70-b059-42ba-9bf2-e3235bfb9aa9%40googlegroups.com.
For more options, visit https://groups.google.com/d/optout.
