Sha256: e7d85c2abe7bf4cf12fc56a5cfa4507e881bf37f503ed939d830170fb6ebbd0e

Contents?: true

Size: 1.78 KB

Versions: 2

Compression:

Stored size: 1.78 KB

Contents

### <a name="<%= link %>"></a>`<%= name %>`

<% if text -%>
<%= text %>
<% elsif summary -%>
<%= summary %>
<% else -%>
<%= "The #{name} data type." %>
<% end -%>

<% if todo -%>
* **TODO** <%= todo %>

<% end -%>
<% if note -%>
* **Note** <%= note %>

<% end -%>
<% if since -%>
* **Since** <%= since %>

<% end -%>
<% if see -%>
* **See also**
<% see.each do |sa| -%>
<% if sa[:name] -%>
<%= "  * #{sa[:name]}" %>
<% end -%>
<% if sa[:text] -%>
<%= "  * #{sa[:text]}" %>
<% end -%>
<% end -%>

<% end -%>
<% if examples -%>
#### Examples

<% examples.each do |eg| -%>
##### <%= eg[:name] %>

```puppet
<%= eg[:text] %>
```

<% end -%>
<% end -%>
<% if alias_of -%>
Alias of<%= code_maybe_block(alias_of) %>

<% end -%>
<% if params -%>
#### Parameters

The following parameters are available in the `<%= name %>` <%= @type %>:

<% params.each do |param| -%>
* [`<%= param[:name] %>`](#<%= param[:link] %>)
<% end -%>

<% params.each do |param| -%>
##### <a name="<%= param[:link] %>"></a>`<%= param[:name] %>`

<% if param[:types] -%>
Data type:<%= code_maybe_block(param[:types].join(', ')) %>

<% end -%>
<%= param[:text] %>

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

<% options_for_param(param[:name]).each do |o| -%>
* **<%= o[:opt_name] %>** `<%= o[:opt_types][0] %>`: <%= o[:opt_text] %>
<% end -%>

<% end -%>
<% if enums_for_param(param[:name]) -%>
Options:

<% enums_for_param(param[:name]).each do |e| -%>
* **<%= e[:opt_name] %>**: <%= e[:opt_text] %>
<% end -%>

<% end -%>
<% if defaults && defaults[param[:name]] -%>
Default value:<%= code_maybe_block(defaults[param[:name]]) %>

<% end -%>
<% end -%>
<% end -%>
<% if functions -%>
#### Functions

The following functions are available in the `<%= name %>` <%= @type %>.

<% functions.each do |func| -%><%= func.render -%><% end -%>
<% end -%>

Version data entries

2 entries across 2 versions & 1 rubygems

Version Path
puppet-strings-3.0.1 lib/puppet-strings/markdown/templates/data_type.erb
puppet-strings-3.0.0 lib/puppet-strings/markdown/templates/data_type.erb