(FM-7963) Yard doc for serverspec #99
Conversation
|
I don't see a rake task for this. How do the docs get generated? |
tphoney
changed the title
|
working on it :) |
tphoney
force-pushed
the
yard_serverspec
branch
from
ad0a9b1
to
dc1bb6f
Compare
|
|
tphoney
changed the title
tphoney
force-pushed
the
yard_serverspec
branch
from
dc1bb6f
to
111efad
Compare
|
comments are a pain, rubocop and yard fighting. |
| def idempotent_apply(manifest) | ||
| manifest_file_location = create_manifest_file(manifest) | ||
| apply_manifest(nil, catch_failures: true, manifest_file_location: manifest_file_location) | ||
| apply_manifest(nil, catch_changes: true, manifest_file_location: manifest_file_location) | ||
| end | ||
|
|
||
| # rubocop:disable Layout/TrailingWhitespace |
There was a problem hiding this comment.
Is the trailing whitespace needed? I think that in Puppet Strings (which is also Yard based) it isn't needed. Or is it to force a newline?
There was a problem hiding this comment.
it is to force the newline, to make it easier to read.
| # Applies a manifest. returning the result of that apply. Mimics the apply_manifest from beaker | ||
| # | ||
| # @param manifest [String] puppet manifest code to be applied. | ||
| # @param opts [Hash] Alters the behaviour of the command. Valid options are: |
There was a problem hiding this comment.
Long term it'd be nice to change the API to explicitly accept these parameters rather than squashing them in opts, but let's at least document them :)
There was a problem hiding this comment.
It was to provide some backwards compatibility for the beaker helper. i agree with you
No description provided.