Skip to content

Commit eaa3d58

Browse files
committed
(PDOC-165) Bump version to 1.1.0 and update CHANGELOG
1 parent ba1a653 commit eaa3d58

File tree

2 files changed

+13
-1
lines changed

2 files changed

+13
-1
lines changed

CHANGELOG.md

Lines changed: 12 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,15 @@
1+
##2017-03-20 - Release 1.1.0
2+
3+
###Summary
4+
5+
This release adds a new `summary` tag which can be used to add a short description to classes, functions, types, and providers. In addition, `@param` tags can now include type information in Puppet 4 code without warnings being issued.
6+
7+
All related tickets can be found under the [PDOC](https://tickets.puppetlabs.com/browse/PDOC) JIRA project with the fix version of [1.1.0](https://tickets.puppetlabs.com/issues/?filter=25603).
8+
9+
###Features
10+
- The `summary` tag can be added to any code that puppet-strings supports. The recommended length limit for a summary is 140 characters. Warnings will be issued for strings longer than this limit.
11+
- Puppet 4 parameter types can now be explicitly documented. Previously, this was not allowed because Puppet 4 parameter types can be automatically determined without extra documentation. However, users may desire to do so anyway for consistency. Strings will emit a warning if the documented type does not match the actual type. In such an event, the incorrect documented type will be ignored in favor of the real one.
12+
113
##2016-11-28 - Release 1.0.0
214

315
###Summary

puppet-strings.gemspec

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
11
Gem::Specification.new do |s|
22
s.name = 'puppet-strings'
33
s.author = 'Puppet Inc.'
4-
s.version = '1.0.0'
4+
s.version = '1.1.0'
55
s.license = 'Apache-2.0'
66
s.summary = 'Puppet documentation via YARD'
77
s.email = 'info@puppet.com'

0 commit comments

Comments
 (0)