All notable changes to this project will be documented in this file.
The format is based on Keep a Changelog and this project adheres to Semantic Versioning.
v4.1.3 - 2024-09-05
- (bug) - Pin yard to < 0.9.37 #401 (jordanbreen28)
- validate: give hint on how to regenerate outdated REFERENCE.md #388 (kenyon)
- (CAT-1688) Upgrade rubocop to
~> 1.50.0#383 (LukasAud) - Allow numerics for templates using code_maybe_block #382 (seanmil)
v4.1.2 - 2023-12-05
- Revert "(maint) - fix rubocop" Leading argument with delegation syntax not supported with ruby 2.7.0 #376 (jordanbreen28)
v4.1.1 - 2023-11-22
v4.1.0 - 2023-07-04
- (CONT-1193) - Add
--providersand--list-providersflags #357 (jordanbreen28)
v4.0.0 - 2023-04-25
v4.0.0.rc.1 - 2023-04-17
v3.0.1 - 2022-10-25
v3.0.0 - 2022-10-21
- (CONT-228) Remove deprecated emit flags #329 (chelnak)
- (CONT-228) Bump ruby version #326 (chelnak)
- (#301) Update minimum Ruby version to 2.5.0 #313 (danielparks)
- (#223) Use code blocks as appropriate in Markdown #319 (danielparks)
- Use tilde heredocs for readability #317 (danielparks)
- (#240) Fix output of default values that are expressions #315 (danielparks)
- (#267) Don’t show “Public X” header without contents #314 (danielparks)
- (#307) Always enable plan parsing #312 (danielparks)
- (#302) Fix warnings generated by ERB.new #308 (danielparks)
- (#304) Fix double backticks in Markdown #305 (danielparks)
- (#300) Fix anchor links in Markdown docs #303 (danielparks)
v2.9.0 - 2021-11-29
- Fix rare undefined method `any?' for nil:NilClass error #289 (sanfrancrisko)
v2.8.0 - 2021-07-19
- (DOCUMENT-1232) Add support for ensurable in types_extras_handler #281 (joshcooper)
- (FIXUP) Check for nil before injecting provider param into Types #285 (scotje)
- README.md: update link to docs #276 (kenyon)
v2.7.0 - 2021-05-17
v2.6.0 - 2021-01-18
- Do not fail in case return tag has no type specified #268 (tiandrey)
- Handle a missing description gracefully #260 (scotje)
- Fix ERB failure - parameters without descriptions #255 (trevor-vaughan)
- puppet_function template: fix tags, source #249 (raemer)
- Handle a missing description gracefully #246 (ekohl)
v2.5.0 - 2020-07-15
- (GH-225) Document functions in Puppet Datatypes #235 (glennsarti)
- Add checks to resource_type handler and code objects #232 (scotje)
- (#227) Inject
providerinto params list for types with providers #231 (scotje)
- (#242) Wrap names in backticks when rendering to markdown #243 (scotje)
- Eliminate trailing spaces w/o descriptions #224 (binford2k)
v2.4.0 - 2020-02-20
- Add missing HTML output support for enum tag #218 (seanmil)
- (PDOC-295) Add @enum tag support for Enum data types #215 (seanmil)
- Expanded default search glob for plans. #214 (Raskil)
v2.3.1 - 2019-09-23
- (maint) Use parameters method instead of json['parameters'] #211 (lucywyman)
- (PDOC-285) Fix data_type_handler for errors and numbers #209 (glennsarti)
v2.3.0 - 2019-07-17
- Add Puppet Data Type documentation #199 (glennsarti)
- (PDOC-283) Fix namespaced symbols #205 (glennsarti)
v2.2.0 - 2019-04-05
- (PDOC-272) Add required features attribute #194 (kris-bosland)
- (maint) Implement a strings:generate:reference task #192 (ekohl)
- (PDOC-265) Add examples to function reference docs #188 (ekohl)
- (PDOC-252) Add describe features to puppet-strings face #183 (kris-bosland)
v2.1.0 - 2018-06-26
- (PDOC-212, PDOC-213) add support for @note and @todo #182 (eputnam)
- (PDOC-255) markdown table of contents update #181 (eputnam)
2.0.0 - 2018-05-11
- (PDOC-238) add generated message to markdown #175 (eputnam)
- (PDOC-228) puppet plan support #168 (eputnam)
- (PDOC-206) support for tasks #161 (eputnam)
- (PDOC-36) fix hack for README urls #176 (eputnam)
- (PDOC-240) add handling for :array node type in rsapi_handler #174 (eputnam)
- (PDOC-159) server urls fix #173 (eputnam)
- (maint) display Plans in markdown table of contents #171 (eputnam)
- (PDOC-233) markdown whitespace fixes #170 (JohnLyman)
- (PDOC-229) fix error with return_type and @return #169 (eputnam)
- (PDOC-36) hack to fix README links in generated HTML #167 (eputnam)
- (PDOC-192) remove warning for title/name #166 (eputnam)
- (maint) add condition for misleading warning #155 (eputnam)
1.2.1 - 2018-03-01
1.2.0 - 2018-02-28
- (PDOC-184) generate markdown #156 (eputnam)
- (PDK-437) Add support for Resource API types #153 (DavidS)
- Fix return type matching for Puppet functions #159 (pegasd)
- Add rgen as a runtime dependency #149 (rnelson0)
1.1.1 - 2017-10-20
- (PDOC-160) Remove the timestamp from output #137 (GeoffWilliams)
- Fix args handling for rake strings::generate #136 (hashar)
1.1.0 - 2017-03-20
- (PDOC-161) Add
summarytag for short descriptions #138 (whopper) - (PDOC-155) Allow type documentation in Puppet 4 code #132 (whopper)
1.0.0 - 2016-11-28
- (PDOC-136) Detect return type syntax in Puppet Language functions #126 (whopper)
- (PDOC-135) Detect
return_typecalls in 4.x function dispatches #125 (whopper) - (PDOC-121) Include tag or SHA in gh_pages task commit #121 (whopper)
- (PDOC-125) Display all puppet function signatures in top-level signature key #119 (whopper)
- (PDOC-93) Ensure search bar doesn't overlap item list in nav bar #123 (whopper)
- (PDOC-129) Include tags in overload objects when serialized as JSON #122 (whopper)
- (PDOC-126) Remove
%Qruby quotation syntax from parsed strings #118 (whopper) - (PDOC-127) Strip whitespace from type feature docstrings #112 (whopper)
- (PDOC-95) Properly group and display multiple provider
defaultfors #111 (whopper) - (PDOC-122) Properly parse
newfunctioncalls with newlines #110 (whopper)
0.99.0 - 2016-10-10
- (PDOC-80) Remove runtime dependency on puppet #103 (whopper)
- (PDOC-63) Code refactoring, fix up, and lots of new functionality. #98 (peterhuene)
- (PDOC-71) Workaround for spurious error failures #90 (trevor-vaughan)
- Add Puppet type name in front of the provider name #80 (dmitryilyin)
0.4.0 - 2016-03-30
- (PDOC-75) Work with both versions of 'interpret_any' #77 (HAIL9000)
- (PDOC-70) Always generate the JSON doc when running the rake task #72 (garethr)
- Fix issue running strings:generate without a yardopts file #71 (garethr)
- (PDOC-23) Emit json #55 (iankronquist)
0.3.1 - 2015-09-22
- make metadata match pmt output #65 (underscorgan)
- Last PR for the Summer #62 (iankronquist)
- Same name type and provider #61 (iankronquist)
0.3.0 - 2015-09-21
- Actually/pdoc 19 #36 (iankronquist)
- Type checking/pdoc 21 #35 (iankronquist)
- Dispatch params/pdoc 37 #33 (iankronquist)
- Types and providers fixes #60 (iankronquist)
- (PDOC-35) Format generated html properly #59 (iankronquist)
- (PDOC-49) Improve warnings #57 (iankronquist)
- (PDOC-45) Puppet 4x functions handle unusual names #53 (iankronquist)
- (MAINT) Add a space between a parameter name type and its description #51 (roidelapluie)
- (PDOC-38) Prevent warnings from being issued twice #50 (iankronquist)
- (PDOC-21) Duplicate warnings #49 (iankronquist)
- (PDOC-21) Only create HostClass parameters once #48 (iankronquist)
- (PDOC-35) Support types and providers #46 (iankronquist)
- (maint) Don't print extraneous "true". #45 (iankronquist)
- (PDOC-21) Check mismatched types in defined types #44 (iankronquist)
- Forgot defined types #42 (iankronquist)
- Nested classes/pdoc 35 #41 (iankronquist)
- (maint) Remove unused code path #38 (iankronquist)
- (PDOC-30) Fix Markdown parsing lists parsing #37 (iankronquist)
- (PDOC-37) Warn when documented name does not match declared name #31 (iankronquist)
0.2.0 - 2015-03-17
- (PDOC-27) Don't require options for 3x functions #26 (HAIL9000)
- (PDOC-24) Add basic templates for functions #22 (HAIL9000)
- (PDOC-17) Add support for YARD tags in puppet code #21 (HAIL9000)
- Make the metadata match what's generated by the PMT #28 (underscorgan)
- (PDOC-25) Fix mangled puppet namespaces #27 (HAIL9000)
- (PDOC-26) Rename Puppetx to PuppetX #25 (HAIL9000)