puppet-strings/CHANGELOG.md

23 lines
1.5 KiB
Markdown
Raw Normal View History

##2015-03-17 - Release 0.2.0
###Summary
This release includes improvements to the HTML output generated by strings and a few bug fixes.
All related tickets can be found under the [PDOC](https://tickets.puppetlabs.com/browse/PDOC) JIRA project with the fix version of [0.2.0](https://tickets.puppetlabs.com/issues/?filter=13760).
####Features
- Custom YARD templates for classes and defined types **(PDOC-17)**
- Improved HMTL output that is more appropriate for Puppet code (especially for parameters)
- Support for the explicit list of YARD tags we will be supporting initially (@param, @return, @since, @example)
- Our own custom YARD templates which can be easily extended and tweaked
- Custom YARD templates for 3.x and 4.x functions **(PDOC-24)**
- Improved HMTL output that is more appropriate for listing several functions on one webpage in addition to being more consistent with the HTML produced for classes and defined types.
- Support for the explicit list of YARD tags we will be supporting initially (@param, @return, @since, @example)
- Our own custom YARD templates which can be easily extended and tweaked
- Addition of RubCop Travis CI job to ensure code quality and consistency **(PDOC-8)**
####Bugfixes
- Puppet namespaces are no longer mangled for nested classes and defined types **(PDOC-25)**
- Strings is now compatible with the renaming of the Puppetx/puppetx namespace to PuppetX/puppet_x **(PDOC-26)**
- Strings will no longer crash when documenting 3x functions with less than two arguments passed into newfunction **(PDOC-27)**