Skip to content

Commit bdba6bb

Browse files
committed
Re-word docstring for LogParser#parse_file
1 parent c67b2e8 commit bdba6bb

File tree

1 file changed

+5
-5
lines changed

1 file changed

+5
-5
lines changed

puppet-profile-parser.rb

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -569,11 +569,11 @@ def initialize
569569

570570
# Parse traces from a logfile
571571
#
572-
# @param file [String] Path to the logfile. Paths ending in `.gz` will
573-
# be read using a `Zlib::GzipReader`.
574-
# @param file [IO] `IO` object that returns Puppet Server log lines.
575-
# The `close` method will be called on the `IO` instance as a result
576-
# of parsing.
572+
# @param file [String, IO] A String instance giving a path to the logfile.
573+
# Paths ending in `.gz` will be read using a `Zlib::GzipReader`.
574+
# An `IO` object that returns Puppet Server log lines may also be passed.
575+
# The `close` method will be called on the passed `IO` instance when
576+
# parsing completes.
577577
#
578578
# @return [void]
579579
def parse_file(file)

0 commit comments

Comments
 (0)