Skip to content

Commit 277deec

Browse files
Fix ERB failure - parameters without descriptions
* The resource_type ERB file would fail on parameters without descriptions. These are a warning but should not cause a hard failure * Added a log message to help isolate the file where issues are occurring
1 parent fa7ed23 commit 277deec

File tree

2 files changed

+8
-2
lines changed

2 files changed

+8
-2
lines changed

lib/puppet-strings/markdown/base.rb

Lines changed: 6 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -179,8 +179,12 @@ def word_wrap(text, line_width: 120, break_sequence: "\n")
179179

180180
# @return [String] full markdown rendering of a component
181181
def render(template)
182-
file = File.join(File.dirname(__FILE__),"templates/#{template}")
183-
ERB.new(File.read(file), nil, '-').result(binding)
182+
begin
183+
file = File.join(File.dirname(__FILE__),"templates/#{template}")
184+
ERB.new(File.read(file), nil, '-').result(binding)
185+
rescue => e
186+
fail "Processing #{@registry[:file]}:#{@registry[:line]} with #{file} => #{e}"
187+
end
184188
end
185189

186190
private

lib/puppet-strings/markdown/templates/resource_type.erb

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -120,7 +120,9 @@ Aliases: `<%= param[:aliases].to_s.delete('{').delete('}') %>`
120120
Data type: `<%= param[:data_type] %>`<%= "\n_\*this data type contains a regex that may not be accurately reflected in generated documentation_" if regex_in_data_type?(param[:data_type]) %>
121121

122122
<% end -%>
123+
<% if param[:description] -%>
123124
<%= word_wrap(param[:description]) %>
125+
<% end -%>
124126

125127
<% if options_for_param(param[:name]) -%>
126128
Options:

0 commit comments

Comments
 (0)