Skip to content

Commit ba7dfc8

Browse files
committed
Documentation housekeeping
This commit comprises minor documentation updates as flagged by Puppet Strings. This includes: - Moving the Japanese README to the root of the project (YARD does not know how to parse a readmes directory). - Update class documentation to include the name of the parameter. - Add a minimal description to the Augeas provider.
1 parent a44a363 commit ba7dfc8

File tree

3 files changed

+3
-1
lines changed

3 files changed

+3
-1
lines changed
File renamed without changes.

lib/puppet/provider/augeas/augeas.rb

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -21,6 +21,8 @@
2121
require_relative '../../../puppet_x/augeas/util/parser'
2222

2323
Puppet::Type.type(:augeas).provide(:augeas) do
24+
desc 'The Augeas provider'
25+
2426
include Puppet::Util
2527
include Puppet::Util::Diff
2628
include Puppet::Util::Package

lib/puppet_x/augeas/util/parser.rb

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -30,7 +30,7 @@ module PuppetX::Augeas::Util::Parser
3030
# support the full quite of escape sequences that Ruby allows in
3131
# double-quoted strings.
3232
#
33-
# @param [String] The string to be parsed.
33+
# @param string [String] The string to be parsed.
3434
# @return [Array<String>] The parsed array elements, including handling any
3535
# escape sequences.
3636
def parse_to_array(string)

0 commit comments

Comments
 (0)