Skip to content

Commit

Permalink
(PDOC-52) Fix section on Type directives
Browse files Browse the repository at this point in the history
This confusion persists from a very old attempt at implementing support for
types and providers.
  • Loading branch information
iankronquist committed Sep 14, 2015
1 parent 08ded0c commit 5f8eec8
Showing 1 changed file with 2 additions and 2 deletions.
4 changes: 2 additions & 2 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand All @@ -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

Expand Down

0 comments on commit 5f8eec8

Please sign in to comment.