From 72411807f1dde0dc60c6f3234986ccbc6df91b8e Mon Sep 17 00:00:00 2001 From: Hailee Kenney Date: Tue, 17 Mar 2015 15:25:10 -0700 Subject: [PATCH] (maint) Add CHANGELOG and update for 0.2.0 release --- CHANGELOG.md | 22 ++++++++++++++++++++++ 1 file changed, 22 insertions(+) create mode 100644 CHANGELOG.md diff --git a/CHANGELOG.md b/CHANGELOG.md new file mode 100644 index 0000000..9a9f7a0 --- /dev/null +++ b/CHANGELOG.md @@ -0,0 +1,22 @@ +##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 Ruby 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)** +