puppet-strings 2.4.0 → 2.8.0

data/lib/puppet-strings/yard/parsers/puppet/statement.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 require 'puppet'
 require 'puppet/pops'
 
@@ -32,11 +34,13 @@ module PuppetStrings::Yard::Parsers::Puppet
       comment = []
       (0..@line-2).reverse_each do |index|
         break unless index <= lines.count
+
         line = lines[index].strip
         count = line.size
         line.gsub!(COMMENT_REGEX, '')
         # Break out if nothing was removed (wasn't a comment line)
         break unless line.size < count
+
         comment << line
       end
       @comments_range = (@line - comment.size - 1..@line - 1)

data/lib/puppet-strings/yard/tags.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 # The module for custom YARD tags.
 module PuppetStrings::Yard::Tags
   require 'puppet-strings/yard/tags/factory'

data/lib/puppet-strings/yard/tags/enum_tag.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 require 'yard/tags/option_tag'
 
 # Implements an enum tag for describing enumerated value data types

data/lib/puppet-strings/yard/tags/factory.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 require 'yard/tags/default_factory'
 require 'puppet-strings/yard/tags/enum_tag'
 

data/lib/puppet-strings/yard/tags/overload_tag.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 # Implements an overload tag for Puppet functions
 #
 # This differs from Yard's overload tag in that the signatures are formatted according to Puppet language rules.
@@ -22,7 +24,7 @@ class PuppetStrings::Yard::Tags::OverloadTag < YARD::Tags::Tag
     args = @parameters.map do |parameter|
       name, default = parameter
       tag = tags.find { |t| t.name == name } if tags
-      type = tag && tag.types ? "#{tag.type} " : 'Any '
+      type = tag&.types ? "#{tag.type} " : 'Any '
       prefix = "#{name[0]}" if name.start_with?('*', '&')
       name = name[1..-1] if prefix
       default = " = #{default}" if default
@@ -75,6 +77,7 @@ class PuppetStrings::Yard::Tags::OverloadTag < YARD::Tags::Tag
   # @return Returns what the method call on the object would return.
   def method_missing(method_name, *args, &block)
     return object.send(method_name, *args, &block) if object.respond_to? method_name
+
     super
   end
 

data/lib/puppet-strings/yard/tags/parameter_directive.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 require 'puppet-strings/yard/code_objects'
 
 # Implements a parameter directive (e.g. #@!puppet.type.param) for documenting Puppet resource types.
@@ -5,14 +7,13 @@ class PuppetStrings::Yard::Tags::ParameterDirective < YARD::Tags::Directive
   # Called to invoke the directive.
   # @return [void]
   def call
-    return unless object && object.respond_to?(:add_parameter)
+    return unless object&.respond_to?(:add_parameter)
+
     # Add a parameter to the resource
     parameter = PuppetStrings::Yard::CodeObjects::Type::Parameter.new(tag.name, tag.text)
-    if tag.types
-      tag.types.each do |value|
+    tag.types&.each do |value|
         parameter.add(value)
       end
-    end
     object.add_parameter parameter
   end
 

data/lib/puppet-strings/yard/tags/property_directive.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 require 'puppet-strings/yard/code_objects'
 
 # Implements a parameter directive (e.g. #@!puppet.type.property) for documenting Puppet resource types.
@@ -5,14 +7,13 @@ class PuppetStrings::Yard::Tags::PropertyDirective < YARD::Tags::Directive
   # Called to invoke the directive.
   # @return [void]
   def call
-    return unless object && object.respond_to?(:add_property)
+    return unless object&.respond_to?(:add_property)
+
     # Add a property to the resource
     property = PuppetStrings::Yard::CodeObjects::Type::Property.new(tag.name, tag.text)
-    if tag.types
-      tag.types.each do |value|
+    tag.types&.each do |value|
         property.add(value)
       end
-    end
     object.add_property property
   end
 

data/lib/puppet-strings/yard/tags/summary_tag.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 # Implements a summary tag for general purpose short descriptions
 
 class PuppetStrings::Yard::Tags::SummaryTag < YARD::Tags::Tag

data/lib/puppet-strings/yard/templates/default/puppet_data_type/html/method_details_list.erb

@@ -0,0 +1,6 @@
+<h2>Data Type Functions</h2>
+<% method_listing.each_with_index do |meth, i| %>
+  <div id="<%= meth.name %>-instance_method"><h3><%= meth.name %></h3>
+  <%= yieldall :object => meth, :owner => object, :index => i %>
+  </div>
+<% end %>

data/lib/puppet-strings/yard/templates/default/puppet_data_type/html/setup.rb

@@ -1,5 +1,13 @@
 # Initializes the template.
 # @return [void]
 def init
-  sections :header, :box_info, :summary, :overview, :note, :todo, T('tags'), :source
+  sections :header, :box_info, :summary, :overview, :note, :todo, T('tags'), :method_details_list, [T('method_details')], :source
+end
+
+def method_listing
+  sort_listing(object.functions)
+end
+
+def sort_listing(list)
+  list.sort_by {|o| [o.scope.to_s, o.name.to_s.downcase] }
 end

data/lib/puppet-strings/yard/templates/default/puppet_function/html/setup.rb

@@ -1,5 +1,5 @@
 # Initializes the template.
 # @return [void]
 def init
-  sections :header, :box_info, :summary, :overview, :note, :todo, [T('tags'), :source]
+  sections :header, :box_info, :summary, :overview, [:note, :todo, T('tags'), :source]
 end

data/lib/puppet-strings/yard/templates/default/puppet_type/html/setup.rb

@@ -16,7 +16,9 @@ end
 def properties
   # Properties are the same thing as parameters (from the documentation standpoint),
   # so reuse the same template but with a different title and data source.
-  @parameters = object.properties || []
+  #
+  # "checks" such as "creates" and "onlyif" are another type of property
+  @parameters = (object.properties || []) + (object.checks || [])
   @parameters.sort_by! { |p| p.name }
   @tag_title = 'Properties'
   erb(:parameters)

data/lib/puppet-strings/yard/util.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 require 'puppet/util'
 
 # The module for various puppet-strings utility helpers.
@@ -24,8 +26,9 @@ module PuppetStrings::Yard::Util
   # @return [String] HTML document with links converted
   def self.github_to_yard_links(data)
     data.scan(/href\=\"\#(.+)\"/).each do |bad_link|
-      data.gsub!("=\"##{bad_link.first}\"", "=\"#label-#{bad_link.first.capitalize.gsub('-', '+')}\"")
+      data = data.gsub("=\"##{bad_link.first}\"", "=\"#label-#{bad_link.first.capitalize.gsub('-', '+')}\"")
     end
+
     data
   end
 

data/lib/puppet/application/strings.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 require 'puppet/application/face_base'
 
 # Implements the 'puppet strings' application.

data/lib/puppet/face/strings.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 require 'puppet/face'
 
 # Implements the 'puppet strings' interface.
@@ -57,6 +59,7 @@ Puppet::Face.define(:strings, '0.0.1') do
       environment = Puppet.lookup(:current_environment)
       environment.modules.each do |mod|
         next unless modules.empty? || modules.include?(mod.name)
+
         db = File.join(mod.path, '.yardoc')
         patterns = PuppetStrings::DEFAULT_SEARCH_PATTERNS.map do |p|
           File.join(mod.path, p)
@@ -145,7 +148,7 @@ Puppet::Face.define(:strings, '0.0.1') do
   def check_required_features
     raise RuntimeError, "The 'yard' gem must be installed in order to use this face." unless Puppet.features.yard?
     raise RuntimeError, "The 'rgen' gem must be installed in order to use this face." unless Puppet.features.rgen?
-    raise RuntimeError, 'This face requires Ruby 1.9 or greater.' if RUBY_VERSION =~ /^1\.8/
+    raise RuntimeError, 'This face requires Ruby 1.9 or greater.' if RUBY_VERSION.match?(/^1\.8/)
   end
 
   # Builds the options to PuppetStrings.generate.

data/lib/puppet/feature/rgen.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 require 'puppet/util/feature'
 
 Puppet.features.add(:rgen, :libs => ['rgen/metamodel_builder', 'rgen/ecore/ecore'])

data/lib/puppet/feature/yard.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 require 'puppet/util/feature'
 
 Puppet.features.add(:yard, :libs => ['yard'])

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: puppet-strings
 version: !ruby/object:Gem::Version
-  version: 2.4.0
+  version: 2.8.0
 platform: ruby
 authors:
 - Puppet Inc.
-autorequire: 
+autorequire:
 bindir: bin
 cert_chain: []
-date: 2020-02-20 00:00:00.000000000 Z
+date: 2021-07-19 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: yard
@@ -50,16 +50,10 @@ extra_rdoc_files:
 - README.md
 files:
 - CHANGELOG.md
-- CODEOWNERS
 - COMMITTERS.md
 - CONTRIBUTING.md
-- Gemfile
-- HISTORY.md
-- JSON.md
 - LICENSE
 - README.md
-- Rakefile
-- codecov.yml
 - lib/puppet-strings.rb
 - lib/puppet-strings/describe.rb
 - lib/puppet-strings/json.rb
@@ -82,6 +76,7 @@ files:
 - lib/puppet-strings/markdown/table_of_contents.rb
 - lib/puppet-strings/markdown/templates/classes_and_defines.erb
 - lib/puppet-strings/markdown/templates/data_type.erb
+- lib/puppet-strings/markdown/templates/data_type_function.erb
 - lib/puppet-strings/markdown/templates/function.erb
 - lib/puppet-strings/markdown/templates/puppet_task.erb
 - lib/puppet-strings/markdown/templates/resource_type.erb
@@ -157,6 +152,7 @@ files:
 - lib/puppet-strings/yard/templates/default/puppet_class/html/todo.erb
 - lib/puppet-strings/yard/templates/default/puppet_data_type/html/box_info.erb
 - lib/puppet-strings/yard/templates/default/puppet_data_type/html/header.erb
+- lib/puppet-strings/yard/templates/default/puppet_data_type/html/method_details_list.erb
 - lib/puppet-strings/yard/templates/default/puppet_data_type/html/note.erb
 - lib/puppet-strings/yard/templates/default/puppet_data_type/html/overview.erb
 - lib/puppet-strings/yard/templates/default/puppet_data_type/html/setup.rb
@@ -227,49 +223,11 @@ files:
 - lib/puppet/face/strings.rb
 - lib/puppet/feature/rgen.rb
 - lib/puppet/feature/yard.rb
-- misc/ANNOUNCEMENT_TEMPLATE.md
-- spec/acceptance/emit_json_options_spec.rb
-- spec/acceptance/generate_markdown_spec.rb
-- spec/acceptance/running_strings_generate_spec.rb
-- spec/fixtures/acceptance/modules/test/functions/add.pp
-- spec/fixtures/acceptance/modules/test/lib/puppet/functions/4x_function.rb
-- spec/fixtures/acceptance/modules/test/lib/puppet/parser/functions/function3x.rb
-- spec/fixtures/acceptance/modules/test/lib/puppet/provider/server/linux.rb
-- spec/fixtures/acceptance/modules/test/lib/puppet/type/database.rb
-- spec/fixtures/acceptance/modules/test/manifests/init.pp
-- spec/fixtures/acceptance/modules/test/manifests/triple_nested_classes.pp
-- spec/fixtures/acceptance/modules/test/metadata.json
-- spec/fixtures/acceptance/modules/test/types/elephant.pp
-- spec/fixtures/unit/markdown/output.md
-- spec/fixtures/unit/markdown/output_with_data_types.md
-- spec/fixtures/unit/markdown/output_with_plan.md
-- spec/spec_helper.rb
-- spec/spec_helper_acceptance.rb
-- spec/spec_helper_acceptance_local.rb
-- spec/unit/puppet-strings/describe_spec.rb
-- spec/unit/puppet-strings/json_spec.rb
-- spec/unit/puppet-strings/markdown/base_spec.rb
-- spec/unit/puppet-strings/markdown_spec.rb
-- spec/unit/puppet-strings/yard/code_objects/task_spec.rb
-- spec/unit/puppet-strings/yard/handlers/json/task_handler_spec.rb
-- spec/unit/puppet-strings/yard/handlers/puppet/class_handler_spec.rb
-- spec/unit/puppet-strings/yard/handlers/puppet/data_type_alias_handler_spec.rb
-- spec/unit/puppet-strings/yard/handlers/puppet/defined_type_handler_spec.rb
-- spec/unit/puppet-strings/yard/handlers/puppet/function_handler_spec.rb
-- spec/unit/puppet-strings/yard/handlers/ruby/data_type_handler_spec.rb
-- spec/unit/puppet-strings/yard/handlers/ruby/function_handler_spec.rb
-- spec/unit/puppet-strings/yard/handlers/ruby/provider_handler_spec.rb
-- spec/unit/puppet-strings/yard/handlers/ruby/rsapi_handler_spec.rb
-- spec/unit/puppet-strings/yard/handlers/ruby/type_handler_spec.rb
-- spec/unit/puppet-strings/yard/parsers/json/parser_spec.rb
-- spec/unit/puppet-strings/yard/parsers/json/task_statement_spec.rb
-- spec/unit/puppet-strings/yard/parsers/puppet/parser_spec.rb
-- spec/unit/puppet-strings/yard/util_spec.rb
 homepage: https://github.com/puppetlabs/puppet-strings
 licenses:
 - Apache-2.0
 metadata: {}
-post_install_message: 
+post_install_message:
 rdoc_options: []
 require_paths:
 - lib
@@ -277,16 +235,17 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
-      version: 2.1.0
+      version: 2.3.0
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
       version: '0'
 requirements:
-- puppet, >= 4.0.0
-rubygems_version: 3.0.4
-signing_key: 
+- puppet, >= 5.0.0
+rubyforge_project:
+rubygems_version: 2.7.6.2
+signing_key:
 specification_version: 4
 summary: Puppet documentation via YARD
 test_files: []

data/CODEOWNERS

@@ -1 +0,0 @@
-* @puppet-strings-maintainers

data/Gemfile

@@ -1,53 +0,0 @@
-source ENV['GEM_SOURCE'] || "https://rubygems.org"
-
-gemspec
-
-gem 'rgen'
-gem 'redcarpet'
-gem 'yard', '~> 0.9.11'
-
-if ENV['PUPPET_GEM_VERSION']
-  gem 'puppet', ENV['PUPPET_GEM_VERSION'], :require => false
-else
-  gem 'puppet', :require => false
-end
-
-group :test do
-  gem 'codecov'
-  gem 'mocha'
-  gem 'puppetlabs_spec_helper'
-  gem 'serverspec'
-  gem 'simplecov-console'
-  gem 'rspec', '~> 3.1'
-  gem 'json_spec', '~> 1.1', '>= 1.1.5'
-end
-
-group :acceptance do
-  # Litmus has dependencies which require Ruby 2.5 (Puppet 6) or above.
-  if Gem::Version.new(RUBY_VERSION.dup) >= Gem::Version.new('2.5.0')
-    # Until https://github.com/puppetlabs/puppet_litmus/pull/248 is merged we need to use the source of the
-    # of the PR.  Not the greatest and prone to error, but without it, all litmus based testing is broken.
-    # This can be reverted once this PR is merged and Litmus is released with this fix.
-    gem 'puppet_litmus', git: 'https://github.com/michaeltlombardi/puppet_litmus', ref: 'maint/master/fix-upload-file'
-    gem 'net-ssh', '~> 5.2'
-  end
-end
-
-group :development do
-  gem 'github_changelog_generator', git: 'https://github.com/skywinder/github-changelog-generator', ref: '20ee04ba1234e9e83eb2ffb5056e23d641c7a018' if Gem::Version.new(RUBY_VERSION.dup) >= Gem::Version.new('2.2.2')
-  gem 'pry'
-  gem 'pry-byebug'
-end
-
-gem 'rubocop-rspec'
-gem 'rubocop', '~> 0.57.2'
-
-# Evaluate Gemfile.local if it exists
-if File.exists? "#{__FILE__}.local"
-  eval(File.read("#{__FILE__}.local"), binding)
-end
-
-# Evaluate ~/.gemfile if it exists
-if File.exists?(File.join(Dir.home, '.gemfile'))
-  eval(File.read(File.join(Dir.home, '.gemfile')), binding)
-end

data/HISTORY.md

@@ -1,218 +0,0 @@
-# Previous Changes
-
-## [2.0.0](https://github.com/puppetlabs/puppet-strings/tree/2.0.0) (2018-05-11)
-
-[Full Changelog](https://github.com/puppetlabs/puppet-strings/compare/1.2.1...2.0.0)
-
-### Changed
-
-- bump required ruby and puppet versions [\#178](https://github.com/puppetlabs/puppet-strings/pull/178) ([eputnam](https://github.com/eputnam))
-
-### Added
-
-- \(PDOC-238\) add generated message to markdown [\#175](https://github.com/puppetlabs/puppet-strings/pull/175) ([eputnam](https://github.com/eputnam))
-- \(PDOC-228\) puppet plan support [\#168](https://github.com/puppetlabs/puppet-strings/pull/168) ([eputnam](https://github.com/eputnam))
-- \(PDOC-206\) support for tasks [\#161](https://github.com/puppetlabs/puppet-strings/pull/161) ([eputnam](https://github.com/eputnam))
-
-### Fixed
-
-- \(PDOC-36\) fix hack for README urls [\#176](https://github.com/puppetlabs/puppet-strings/pull/176) ([eputnam](https://github.com/eputnam))
-- \(PDOC-240\) add handling for :array node type in rsapi\_handler [\#174](https://github.com/puppetlabs/puppet-strings/pull/174) ([eputnam](https://github.com/eputnam))
-- \(PDOC-159\) server urls fix [\#173](https://github.com/puppetlabs/puppet-strings/pull/173) ([eputnam](https://github.com/eputnam))
-- \(maint\) display Plans in markdown table of contents [\#171](https://github.com/puppetlabs/puppet-strings/pull/171) ([eputnam](https://github.com/eputnam))
-- \(PDOC-233\) markdown whitespace fixes [\#170](https://github.com/puppetlabs/puppet-strings/pull/170) ([JohnLyman](https://github.com/JohnLyman))
-- \(PDOC-229\) fix error with return\_type and @return [\#169](https://github.com/puppetlabs/puppet-strings/pull/169) ([eputnam](https://github.com/eputnam))
-- \(PDOC-36\) hack to fix README links in generated HTML [\#167](https://github.com/puppetlabs/puppet-strings/pull/167) ([eputnam](https://github.com/eputnam))
-- \(PDOC-192\) remove warning for title/name [\#166](https://github.com/puppetlabs/puppet-strings/pull/166) ([eputnam](https://github.com/eputnam))
-- \(maint\) add condition for misleading warning [\#155](https://github.com/puppetlabs/puppet-strings/pull/155) ([eputnam](https://github.com/eputnam))
-
-## [1.2.1](https://github.com/puppetlabs/puppet-strings/tree/1.2.1) (2018-03-01)
-
-[Full Changelog](https://github.com/puppetlabs/puppet-strings/compare/1.2.0...1.2.1)
-
-### Fixed
-
-- (PDOC-224) Handle --emit-json(-stdout) again [\#162](https://github.com/puppetlabs/puppet-strings/pull/162) ([ekohl](https://github.com/ekohl))
-
-## [1.2.0](https://github.com/puppetlabs/puppet-strings/tree/1.2.0) (2018-02-26)
-
-[Full Changelog](https://github.com/puppetlabs/puppet-strings/compare/1.1.1...1.2.0)
-
-### Added
-
-- \(PDOC-184\) generate markdown [\#156](https://github.com/puppetlabs/puppet-strings/pull/156) ([eputnam](https://github.com/eputnam))
-- \(PDK-437\) Add support for Resource API types [\#153](https://github.com/puppetlabs/puppet-strings/pull/153) ([DavidS](https://github.com/DavidS))
-
-### Fixed
-
-- Fix return type matching for Puppet functions [\#159](https://github.com/puppetlabs/puppet-strings/pull/159) ([pegasd](https://github.com/pegasd))
-- Add rgen as a runtime dependency [\#149](https://github.com/puppetlabs/puppet-strings/pull/149) ([rnelson0](https://github.com/rnelson0))
-
-## 2017-10-20 - Release 1.1.1
-
-### BugFixes
-- Remove timestamps from footer of generated HTML pages ([GeoffWilliams](https://github.com/GeoffWilliams))
-- Fix argument handling for `rake strings::generate` ([hashar](https://github.com/hashar))
-
-### Other
-- Fixed Markdown formatting issues in CHANGELOG ([maju6406](https://github.com/maju6406))
-- Fixed typo in README ([hfm](https://github.com/hfm))
-- Fixed Markdown formatting issues in README ([gguillotte](https://github.com/gguillotte))
-- Update Travis CI configurations for Ruby and Puppet versions ([ghoneycutt](https://github.com/ghoneycutt))
-
-## 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
-
-### Summary
-
-This release fixes up minor bugs from the 0.99.0 release and modifies the JSON schema for Puppet functions.
-
-All related tickets can be found under the [PDOC](https://tickets.puppetlabs.com/browse/PDOC) JIRA project with the fix version of [1.0.0](https://tickets.puppetlabs.com/issues/?filter=23607).
-
-### Features
-- The JSON schema for Puppet functions has been altered to include a new 'signatures' top-level key **(PDOC-125)**
-  - Includes information about all function signatures (overloads). Existing overload key format has been preserved.
-- Reworked README for enhanced clarity **(PDOC-133)**
-
-### BugFixes
-- Fixed an issue where the search box in the code navigator overlapped list items below it **(PDOC-93)**
-- Strings can now handle multiple `defaultfor` calls in Puppet providers **(PDOC-95)**
-- Fixed an issue preventing the generated \_index.html file from being uploaded to GitHub pages via the gh_pages task **(PDOC-120)**
-- Fixed several issues with String's handling of Puppet 3.x and 4.x function return types **(PDOC-135)**, **(PDOC-136)**
-- Fixed an issue where String's didn't properly parse overloads if no summary description was provided **(PDOC-129)**
-- Strings now correctly handles Puppet 3.x functions when the `newfunction` call is on a newline **(PDOC-122)**
-- Fixed an issue where certain Ruby string constructs were incompletely stripped from some docstrings **(PDOC-126)**
-- Hanging indents from type feature descriptions are now properly stripped **(PDOC-127)**
-
-## 2016-10-10 - Release 0.99.0
-
-### Summary
-
-This release includes a complete rewrite of strings, fixing many bugs from previous versions and generally improving the user experience. This release is intended to be the last stop before the strings major version 1.0 is released, and nearly all of the functionality of the major release is included.
-
-All related tickets can be found under the [PDOC][PDOC JIRA] JIRA project with the fix version of [0.99.0](https://tickets.puppetlabs.com/issues/?filter=22705).
-
-### Features
-- Complete overhaul, including code cleanup, bug fixes and new functionality **(PDOC-63)**
-  - Documentation has been split into sections based on type: puppet 3x API functions, puppet 4x API functions, ruby classes, puppet language functions, types, and providers
-  - New JSON schema organized to reflect the separation of types
-  - Support for custom functions written in the puppet language
-  - Support for puppet function overloads via the create_function 4.x API
-  - YARD bumped to latest version, 0.9.5
-- Markdown is now the default format for parsing docstring text **(PDOC-86)**
-  - Note: this means Markdown text in YARD comments and tags, not a change in the output of strings
-- New commandline options: --emit-json and --emit-json-stdout to generate JSON documentation **(PDOC-84)**
-- Runtime dependency on Puppet has been removed, allowing strings to function in Puppet Enterprise 3.8 **(PDOC-80)**
-  - Note that the gem still requires puppet. We recommend that the strings gem be installed with puppet, as suggested in the  [README](https://github.com/puppetlabs/puppet-strings/blob/master/README.md#installing-puppet-strings)
-- New gemspec requirement on Ruby version 1.9.3, the oldest supported Ruby version
-
-### BugFixes
-
-- Prevents a blizzard of errors when documenting Puppet Core source and some puppet modules **(PDOC-63)**
-  - As this is a complete rewrite, many known and unknown bugs from the original code were fixed along the way
-- Allow strings to be installed in PE 3.8 without overwriting existing puppet and facter installations with newer gems
-
-## 2016-03-30 - Release 0.4.0
-
-### Summary
-
-This release adds JSON output support for strings, fixes a major bug that prevented strings from working with the 4.4.0 release of puppet, and is the last version of strings that will be released as a module.
-
-All related tickets can be found under the [PDOC][PDOC JIRA] JIRA project with the fix version of [0.4.0](https://tickets.puppetlabs.com/issues/?filter=18810).
-
-### Features
-- Support for JSON output **(PDOC-23)**
-  - Strings now has the ability to produce a JSON representation of a given puppet module
-  - The details of the JSON schema can be found [here](https://github.com/puppetlabs/puppet-strings/blob/master/json_dom.md)
-  - For details on how to generate JSON, see the [README](https://github.com/puppetlabs/puppet-strings/blob/master/README.md#running-puppet-strings)
-- Migrate to ruby gems as a distribution method **(PDOC-28)**
-  - This is the last release of strings that will be available as a puppet module
-  - The 0.4.0 release will be released concurrently as a ruby gem
-  - After this release, all updates will only be available via the gem
-
-### Bugfixes
-
-- Fix issue that prevented strings from running with Puppet 4.4.0 **(PDOC-75)**
-
-## 2015-09-22 - Release 0.3.1
-
-### Summary
-
-This is a minor bug fix release.
-
-All related tickets can be found under the [PDOC][PDOC JIRA] JIRA project with the fix version of [0.3.1](https://tickets.puppetlabs.com/issues/?filter=15530).
-
-### Bugfixes
-
-- Prevent strings from printing unnecessary quotes in error messages **(PDOC-57)**
-- Issue correct type check warnings for defined types **(PDOC-56)**
-- Allow providers, types, and defines to have the same name **(PDOC-54)**
-
-## 2015-09-21 - Release 0.3.0
-
-### Summary
-
-This release includes support for Puppet Types and Providers, as well as
-type checking Puppet 4x functions and defined types.
-
-All related tickets can be found under the [PDOC][PDOC JIRA] JIRA project with
-the fix version of [0.3.0](https://tickets.puppetlabs.com/issues/?filter=15529).
-
-#### Features
-
-- Support for Puppet Types and Providers **(PDOC-35)**
-- Type check Puppet 4x functions and defined types where possible and warn the user when types don't match.
-  - Type check defined types **(PDOC-21)**
-  - Type check Puppet 4x functions **(PDOC-38)** **(PDOC-19)** **(PDOC-37)**
-  - Output type info in generated HTML **(PDOC-19)**
-- Improved warnings and logging.
-  - Create a consistent style for warnings. **(PDOC-49)**
-  - All warnings get printed on stderr.
-  - Yard warnings are redirected to a log file **(PDOC-38)**
-  - Prevent duplicate warnings **(PDOC-38)**
-- Improved README installation and usage instructions.
-  - Installation instructions using Puppet **(PDOC-33)**
-
-
-#### Bugfixes
-
-- Fix markdown list processing **(PDOC-30)**
-- Fix namespacing for nested classes and defined types **(PDOC-20)**
-
-
-## 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][PDOC JIRA] JIRA project with the fix version of [0.2.0](https://tickets.puppetlabs.com/issues/?filter=13760).
-
-[PDOC JIRA]: https://tickets.puppetlabs.com/browse/PDOC
-
-#### 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)**