Merge pull request #171 from eputnam/plans_toc

(maint) display Plans in markdown table of contents
puppetlabs · Apr 4, 2018 · 99c53d1 · 99c53d1
2 parents a4e9150 + d4ca490
commit 99c53d1
Show file tree

Hide file tree

Showing 3 changed files with 7 additions and 2 deletions.
diff --git a/lib/puppet-strings/markdown/puppet_plans.rb b/lib/puppet-strings/markdown/puppet_plans.rb
@@ -27,7 +27,7 @@ def self.render
     def self.toc_info
       final = ["Plans"]
 
-      in_classes.each do |plan|
+      in_plans.each do |plan|
         final.push(plan.toc_info)
       end
 

diff --git a/lib/puppet-strings/markdown/table_of_contents.rb b/lib/puppet-strings/markdown/table_of_contents.rb
@@ -7,7 +7,8 @@ def self.render
       PuppetStrings::Markdown::DefinedTypes,
       PuppetStrings::Markdown::ResourceTypes,
       PuppetStrings::Markdown::Functions,
-      PuppetStrings::Markdown::PuppetTasks].each do |r|
+      PuppetStrings::Markdown::PuppetTasks,
+      PuppetStrings::Markdown::PuppetPlans].each do |r|
         toc = r.toc_info
         group_name = toc.shift
         group = toc

diff --git a/spec/fixtures/unit/markdown/output_with_plan.md b/spec/fixtures/unit/markdown/output_with_plan.md
@@ -30,6 +30,10 @@
 
 * [`(stdin)`](#(stdin)): Allows you to backup your database to local file.
 
+## Plans
+
+* [`plann`](#plann): A simple plan.
+
 ## Classes
 
 ### klass