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

(maint) Fix @param type examples in README 

Correct the examples of using a parameter type in the @param tag
so that they match how the YARD documentation suggests the tag
should be used.

http://www.rubydoc.info/gems/yard/file/docs/Tags.md#param
This commit is contained in:
Hailee Kenney 2016-12-19 23:22:48 -08:00
parent 5ae446fcba
commit 303c1eda1f
1 changed files with 4 additions and 4 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

8
README.md
View File

@ -213,8 +213,8 @@ The Strings elements appearing in the above comment block are:
Puppet 4 is a typed language, so Puppet Strings automatically documents the parameter types from code. With Puppet 3, however, include the parameter type with the `@param` tag:
```
# @param [String] first The first parameter for this class.
# @param [Integer] second The second parameter for this class.
# @param first [String] The first parameter for this class.
# @param second [Integer] The second parameter for this class.
```
Note that if you document a parameter's type, and that parameter already has a Puppet type specifier, Strings emits a warning.
@ -346,8 +346,8 @@ To document a function in the Puppet 3 API, use the `doc` option to `newfunction
```ruby
Puppet::Parser::Functions.newfunction(:example, doc: <<-DOC
Documentation for an example 3.x function.
@param [String] param1 The first parameter.
@param [Integer] param2 The second parameter.
@param param1 [String] The first parameter.
@param param2 [Integer] The second parameter.
@return [Undef]
@example Calling the function.
example('hi', 10)