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

(PDOC-52) Fix section on Type directives 

This confusion persists from a very old attempt at implementing support for
types and providers.
This commit is contained in:
Ian Kronquist 2015-09-14 15:20:34 -07:00
parent d2c178b59c
commit 3a2f70026e
1 changed files with 2 additions and 2 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

4
README.md
View File

@ -165,7 +165,7 @@ Here's an example of how you might document a class:
Strings will automatically extract the `@doc` provider docstring and any `desc`
parameter/property docstrings.
Sometimes however, Puppet providers use metaprogramming to create parameters
Sometimes however, Puppet types use metaprogramming to create parameters
and methods automatically. In those cases Strings will not be able to document
them automatically (Strings doesn't execute the code that would generate those
parameters), so you will need to provide hints on how to document your code. To
@ -174,7 +174,7 @@ directive `@!puppet.provider.param` which may take types, the parameter name,
and a description.
```ruby
# @!puppet.provider.param my_parameter This parameter needs to be explicitly
# @!puppet.type.param my_parameter This parameter needs to be explicitly
# documented as it is generated by mk_resource_methods
Puppet::Type.newtype(:minifile) do