Re-word docstring for LogParser#parse_file

Sharpie · May 25, 2018 · bdba6bb · bdba6bb
1 parent c67b2e8
commit bdba6bb
Showing 1 changed file with 5 additions and 5 deletions.
diff --git a/puppet-profile-parser.rb b/puppet-profile-parser.rb
@@ -569,11 +569,11 @@ def initialize
 
     # Parse traces from a logfile
     #
-    # @param file [String] Path to the logfile. Paths ending in `.gz` will
-    #   be read using a `Zlib::GzipReader`.
-    # @param file [IO] `IO` object that returns Puppet Server log lines.
-    #   The `close` method will be called on the `IO` instance as a result
-    #   of parsing.
+    # @param file [String, IO] A String instance giving a path to the logfile.
+    #   Paths ending in `.gz` will be read using a `Zlib::GzipReader`.
+    #   An `IO` object that returns Puppet Server log lines may also be passed.
+    #   The `close` method will be called on the passed `IO` instance when
+    #   parsing completes.
     #
     # @return [void]
     def parse_file(file)