kienan
/
puppet-strings
1
0
Fork 0
Code Issues Pull Requests Releases Wiki Activity

(PDOC-238) add generated message to markdown 

Currently there is no evidence in REFERENCE.md itself that it was generated and should not be edited. This adds a comment in the markdown, so as not to disrupt its rendered appearance but still communicate to the user when editing that the file is generated.
This commit is contained in:
Eric Putnam 2018-04-20 16:25:40 +01:00
parent 2ec1b24051
commit 2d59213b34
No known key found for this signature in database
GPG Key ID: 3FB595AA224A7751
3 changed files with 4 additions and 1 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

3
lib/puppet-strings/markdown.rb
View File

@ -13,7 +13,8 @@ module PuppetStrings::Markdown
# generates markdown documentation # generates markdown documentation
# @return [String] markdown doc # @return [String] markdown doc
def self.generate def self.generate
final = "# Reference\n\n" final = "# Reference\n"
final << "<!-- DO NOT EDIT: This document was generated by Puppet Strings -->\n\n"
final << PuppetStrings::Markdown::TableOfContents.render final << PuppetStrings::Markdown::TableOfContents.render
final << PuppetStrings::Markdown::PuppetClasses.render final << PuppetStrings::Markdown::PuppetClasses.render
final << PuppetStrings::Markdown::DefinedTypes.render final << PuppetStrings::Markdown::DefinedTypes.render

1
spec/fixtures/unit/markdown/output.md vendored
View File

@ -1,4 +1,5 @@
# Reference # Reference
<!-- DO NOT EDIT: This document was generated by Puppet Strings -->
## Classes ## Classes

1
spec/fixtures/unit/markdown/output_with_plan.md vendored
View File

@ -1,4 +1,5 @@
# Reference # Reference
<!-- DO NOT EDIT: This document was generated by Puppet Strings -->
## Classes ## Classes