Skip to content

Commit

Permalink
Merge pull request #425 from mcavigelli/DocFixStream
Browse files Browse the repository at this point in the history
Doc fix stream
fixes #416
  • Loading branch information
mcavigelli committed Aug 21, 2022
2 parents a9c47e4 + 05fdade commit 3975593
Show file tree
Hide file tree
Showing 2 changed files with 4 additions and 4 deletions.
2 changes: 1 addition & 1 deletion FileHelpers/Core/ForwardReader.cs
Original file line number Diff line number Diff line change
Expand Up @@ -24,7 +24,7 @@ internal sealed class ForwardReader
/// Read a Record handler forward, optionally skipping n lines and starting at a record number > 0
/// </summary>
/// <param name="reader">Reader to get records</param>
/// <param name="forwardLines">NUmber of lines to skip before reading</param>
/// <param name="forwardLines">Number of lines to skip before reading</param>
internal ForwardReader(IRecordReader reader, int forwardLines)
: this(reader, forwardLines, 0) {}

Expand Down
6 changes: 3 additions & 3 deletions FileHelpers/Engines/FileHelperEngine.docs.xml
Original file line number Diff line number Diff line change
Expand Up @@ -48,7 +48,7 @@
Read a Stream and return an array of the contained records.
</summary>
<remarks>
This method only uses the stream and does not close them after using it, you must do it.
This method uses the stream and closes it after using it.
</remarks>
<include file='Examples.xml' path='doc/examples/ReadFile/*'/>
<param name="reader">The reader of the source stream.</param>
Expand Down Expand Up @@ -129,7 +129,7 @@
Write an array of records to the specified Stream.
</summary>
<remarks>
This method only uses the stream and don't close them after use it, you must do it.
This method only uses the stream and does not close it, you must do it.
</remarks>
<include file='Examples.xml' path='doc/examples/WriteFile/*'/>
<param name="writer">The writer of the source stream.</param>
Expand All @@ -142,7 +142,7 @@
Write the specified number of records in the array to the Stream.
</summary>
<remarks>
This method only uses the stream and does not close the stream after using it, you must do it.
This method only uses the stream and does not close it, you must do it.
</remarks>
<include file='Examples.xml' path='doc/examples/WriteFile/*'/>
<param name="writer">The writer of the source stream.</param>
Expand Down

0 comments on commit 3975593

Please sign in to comment.