(PDOC-165) Bump version to 1.1.0 and update CHANGELOG
This commit is contained in:
parent
ba1a653331
commit
eaa3d58659
12
CHANGELOG.md
12
CHANGELOG.md
|
@ -1,3 +1,15 @@
|
||||||
|
##2017-03-20 - Release 1.1.0
|
||||||
|
|
||||||
|
###Summary
|
||||||
|
|
||||||
|
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.
|
||||||
|
|
||||||
|
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).
|
||||||
|
|
||||||
|
###Features
|
||||||
|
- 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.
|
||||||
|
- 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.
|
||||||
|
|
||||||
##2016-11-28 - Release 1.0.0
|
##2016-11-28 - Release 1.0.0
|
||||||
|
|
||||||
###Summary
|
###Summary
|
||||||
|
|
|
@ -1,7 +1,7 @@
|
||||||
Gem::Specification.new do |s|
|
Gem::Specification.new do |s|
|
||||||
s.name = 'puppet-strings'
|
s.name = 'puppet-strings'
|
||||||
s.author = 'Puppet Inc.'
|
s.author = 'Puppet Inc.'
|
||||||
s.version = '1.0.0'
|
s.version = '1.1.0'
|
||||||
s.license = 'Apache-2.0'
|
s.license = 'Apache-2.0'
|
||||||
s.summary = 'Puppet documentation via YARD'
|
s.summary = 'Puppet documentation via YARD'
|
||||||
s.email = 'info@puppet.com'
|
s.email = 'info@puppet.com'
|
||||||
|
|
Loading…
Reference in New Issue