Comment why we append --- in the docs generator

Signed-off-by: Tim Smith <tsmith@chef.io>

1 files changed, 2 insertions, 0 deletions

diff --git a/tasks/docs.rb b/tasks/docs.rb
index 67b8950aec..22f70be43a 100755
--- a/tasks/docs.rb
+++ b/tasks/docs.rb
@@ -305,6 +305,8 @@ namespace :docs_site do
       else
         puts "Writing out #{resource}."
         FileUtils.mkdir_p "docs_site/#{resource}"
+        # write out the yaml contents of the hash and append a --- since this is actually a yaml
+        # block in the middle of a markdown page and the block needs an ending
         File.open("docs_site/#{resource}/_index.md", "w") { |f| f.write(resource_data.to_yaml + "---") }
       end
     end