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

(PDOC-233) Make markdown white space formatting consistent 

Replace arbitrary double blank lines with a single blank lines.
This commit is contained in:
John Lyman 2018-03-16 13:21:59 +00:00
parent d9065e6f2e
commit ca26677cad
4 changed files with 9 additions and 21 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

7
lib/puppet-strings/markdown/templates/classes_and_defines.erb
View File

@ -17,9 +17,13 @@
<% if see -%> <% if see -%>
* **See also** * **See also**
<% see.each do |sa| -%> <% see.each do |sa| -%>
<% if sa[:name] -%>
<%= sa[:name] %> <%= sa[:name] %>
<% end -%>
<% if sa[:text] -%>
<%= sa[:text] %> <%= sa[:text] %>
<% end -%> <% end -%>
<% end -%>
<% end -%> <% end -%>
<% if examples -%> <% if examples -%>
@ -34,7 +38,7 @@
<% end -%> <% end -%>
<% end -%> <% end -%>
<% if params %> <% if params -%>
#### Parameters #### Parameters
The following parameters are available in the `<%= name %>` <%= @type %>. The following parameters are available in the `<%= name %>` <%= @type %>.
@ -62,4 +66,3 @@ Default value: <%= value_string(defaults[param[:name]]) %>
<% end -%> <% end -%>
<% end -%> <% end -%>
<% end -%> <% end -%>

5
lib/puppet-strings/markdown/templates/resource_type.erb
View File

@ -17,9 +17,13 @@
<% if see -%> <% if see -%>
* **See also** * **See also**
<% see.each do |sa| -%> <% see.each do |sa| -%>
<% if sa[:name] -%>
<%= sa[:name] %> <%= sa[:name] %>
<% end -%>
<% if sa[:text] -%>
<%= sa[:text] %> <%= sa[:text] %>
<% end -%> <% end -%>
<% end -%>
<% end -%> <% end -%>
<% if examples -%> <% if examples -%>
@ -114,4 +118,3 @@ Default value: <%= value_string(param[:default]) %>
<% end -%> <% end -%>
<% end -%> <% end -%>
<% end -%> <% end -%>

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

@ -41,7 +41,6 @@ An overview for a simple class.
* **See also** * **See also**
www.puppet.com www.puppet.com
#### Examples #### Examples
##### This is an example ##### This is an example
@ -62,7 +61,6 @@ class { 'klass':
} }
``` ```
#### Parameters #### Parameters
The following parameters are available in the `klass` class. The following parameters are available in the `klass` class.
@ -96,7 +94,6 @@ Third param.
Default value: 'hi' Default value: 'hi'
## Defined types ## Defined types
### klass::dt ### klass::dt
@ -108,7 +105,6 @@ An overview for a simple defined type.
* **See also** * **See also**
www.puppet.com www.puppet.com
#### Examples #### Examples
##### Here's an example of this type: ##### Here's an example of this type:
@ -120,7 +116,6 @@ klass::dt { 'foo':
} }
``` ```
#### Parameters #### Parameters
The following parameters are available in the `klass::dt` defined type. The following parameters are available in the `klass::dt` defined type.
@ -160,7 +155,6 @@ Fourth param.
Default value: `true` Default value: `true`
## Resource types ## Resource types
### apt_key ### apt_key
@ -211,7 +205,6 @@ _*this data type contains a regex that may not be accurately reflected in genera
The ID of the key you want to manage. The ID of the key you want to manage.
### database ### database
An example database server type. An example database server type.
@ -274,7 +267,6 @@ Whether or not to encrypt the database.
Default value: `false` Default value: `false`
## Functions ## Functions
### func ### func

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

@ -41,7 +41,6 @@ An overview for a simple class.
* **See also** * **See also**
www.puppet.com www.puppet.com
#### Examples #### Examples
##### This is an example ##### This is an example
@ -62,7 +61,6 @@ class { 'klass':
} }
``` ```
#### Parameters #### Parameters
The following parameters are available in the `klass` class. The following parameters are available in the `klass` class.
@ -96,7 +94,6 @@ Third param.
Default value: 'hi' Default value: 'hi'
## Defined types ## Defined types
### klass::dt ### klass::dt
@ -108,7 +105,6 @@ An overview for a simple defined type.
* **See also** * **See also**
www.puppet.com www.puppet.com
#### Examples #### Examples
##### Here's an example of this type: ##### Here's an example of this type:
@ -120,7 +116,6 @@ klass::dt { 'foo':
} }
``` ```
#### Parameters #### Parameters
The following parameters are available in the `klass::dt` defined type. The following parameters are available in the `klass::dt` defined type.
@ -160,7 +155,6 @@ Fourth param.
Default value: `true` Default value: `true`
## Resource types ## Resource types
### apt_key ### apt_key
@ -211,7 +205,6 @@ _*this data type contains a regex that may not be accurately reflected in genera
The ID of the key you want to manage. The ID of the key you want to manage.
### database ### database
An example database server type. An example database server type.
@ -274,7 +267,6 @@ Whether or not to encrypt the database.
Default value: `false` Default value: `false`
## Functions ## Functions
### func ### func
@ -449,7 +441,6 @@ Path to file you want backup to
A simple plan. A simple plan.
#### Parameters #### Parameters
The following parameters are available in the `plann` plan. The following parameters are available in the `plann` plan.
@ -474,4 +465,3 @@ Third param.
Default value: 1 Default value: 1