improve docs and param rename

Author: leandromoh

RecordParser.Test/FileReaderTest.cs

@@ -574,11 +574,12 @@ public record RegularCaseRecord(int Aaa, int Bbb, int Ccc, int Ddd);
 
         [Theory]
         [InlineData("\"AAA\",\"BBB\",\"CCC\",\"DDD\"")]
+        [InlineData("Aaa,Bbb,Ccc,Ddd")]
         [InlineData("AAA,BBB,CCC,DDD")]
         [InlineData("aaa,bbb,ccc,ddd")]
         [InlineData("AAA , BBB , CCC , DDD")]
         [InlineData("A_AA,B_BB,C_CC,D_DD")]
-        public void Read_csv_file_with_header_in_different_case_should_automatic_bind_mapping(string header)
+        public void Read_csv_file_with_autobind_should_match_header_case_insensitive(string header)
         {
             // Arrange
 
@@ -614,15 +615,15 @@ public void Read_csv_file_with_header_in_different_case_should_automatic_bind_ma
 
             // Act
 
-            var items = reader.ReadRecords<RegularCaseRecord>(readOptions, skipMismatchedColumns: false);
+            var items = reader.ReadRecords<RegularCaseRecord>(readOptions, skipUnmatchedColumns: false);
 
             // Assert
 
             items.Should().BeEquivalentTo(expected, cfg => cfg.WithStrictOrdering());
         }
 
         [Fact]
-        public void Read_csv_file_with_header_should_automatic_bind_support_additional_configuration()
+        public void Read_csv_file_with_autobind_should_support_additional_configuration()
         {
             // Arrange
 
@@ -658,7 +659,7 @@ public void Read_csv_file_with_header_should_automatic_bind_support_additional_c
 
             // Act
 
-            var items = reader.ReadRecords<RegularCaseRecord>(readOptions, false, builder =>
+            var items = reader.ReadRecords<RegularCaseRecord>(readOptions, skipUnmatchedColumns: false, builder =>
                 builder.DefaultTypeConvert(x => int.Parse(x) * 10));
 
             // Assert
@@ -667,7 +668,7 @@ public void Read_csv_file_with_header_should_automatic_bind_support_additional_c
         }
 
         [Fact]
-        public void Read_csv_file_with_header_containing_nested_fields_should_automatic_bind_mapping()
+        public void Read_csv_file_with_autobind_should_support_nested_fields()
         {
             // Arrange
 
@@ -700,15 +701,15 @@ public void Read_csv_file_with_header_containing_nested_fields_should_automatic_
 
             // Act
 
-            var items = reader.ReadRecords<Person>(readOptions, skipMismatchedColumns: false);
+            var items = reader.ReadRecords<Person>(readOptions, skipUnmatchedColumns: false);
 
             // Assert
 
             items.Should().BeEquivalentTo(expected, cfg => cfg.WithStrictOrdering());
         }
 
         [Fact]
-        public void Read_csv_file_with_header_containing_inherited_fields_should_automatic_bind_mapping()
+        public void Read_csv_file_with_autobind_should_support_inherited_properties()
         {
             // Arrange
 
@@ -744,7 +745,7 @@ public void Read_csv_file_with_header_containing_inherited_fields_should_automat
 
             // Act
 
-            var items = reader.ReadRecords<PersonDerivated>(readOptions, skipMismatchedColumns: true);
+            var items = reader.ReadRecords<PersonDerivated>(readOptions, skipUnmatchedColumns: true);
 
             // Assert
 
@@ -755,7 +756,7 @@ public void Read_csv_file_with_header_containing_inherited_fields_should_automat
         [InlineData(" ", false)]
         [InlineData(" ", true)]
         [InlineData("BirthDay ; Name ; Mother.BirthDay; Mother.Name", false)]
-        public void Read_csv_file_without_header_should_throw_when_automatic_bind_mapping(string header, bool hasHeader)
+        public void Read_csv_file_with_autobind_should_throw_when_missing_header(string header, bool hasHeader)
         {
             // Arrange
 
@@ -788,7 +789,7 @@ public void Read_csv_file_without_header_should_throw_when_automatic_bind_mappin
 
             // Act
 
-            var action = () => reader.ReadRecords<Person>(readOptions, skipMismatchedColumns: true);
+            var action = () => reader.ReadRecords<Person>(readOptions, skipUnmatchedColumns: true);
 
             // Assert
 

RecordParser/Extensions/FileReader/FixedLengthReaderExtensions.cs

@@ -13,7 +13,7 @@ public class FixedLengthReaderOptions<T>
         /// </summary>
         public ParallelismOptions ParallelismOptions { get; set; }
         /// <summary>
-        /// Function which parses text into object
+        /// Function which parses text to object
         /// </summary>
         public FuncSpanT<T> Parser { get; set; }
     }
@@ -24,7 +24,7 @@ public static class FixedLengthReaderExtensions
 
         /// <summary>
         /// Reads the records (i.e., lines) from a fixed length file, 
-        /// then parses the records into objects.
+        /// then parses the records to objects.
         /// </summary>
         /// <typeparam name="T">type of objects read from file</typeparam>
         /// <param name="reader">fixed length file</param>

RecordParser/Extensions/FileReader/VariableLengthReaderExtensions.cs

@@ -35,7 +35,7 @@ public static class VariableLengthReaderExtensions
     {
         /// <summary>
         /// Reads the records from a variable length file, 
-        /// then parses the records into objects.
+        /// then parses the records to objects.
         /// </summary>
         /// <typeparam name="T">type of objects read from file</typeparam>
         /// <param name="reader">variable length file</param>
@@ -58,10 +58,29 @@ public static IEnumerable<T> ReadRecords<T>(this TextReader reader, IVariableLen
                 : ReadRecordsSequential(selector, func, options.HasHeader);
         }
 
+        /// <summary>
+        /// Reads the records from a variable length file
+        /// using the header of the file to auto-bind columns to properties in the process of parsing the records to objects. 
+        /// </summary>
+        /// <typeparam name="T">type of objects read from file</typeparam>
+        /// <param name="reader">variable length file</param>
+        /// <param name="options">options to configure the parsing</param>
+        /// <param name="skipUnmatchedColumns">
+        /// If true then header columns without a matching property or field will simply be ignored;
+        /// otherwise, an exception will be thrown indicating the non-matching column.
+        /// Default value is true.
+        /// </param>
+        /// <param name="action">callback to set additional bind or default type converters</param>
+        /// <returns>
+        /// Sequence of records.
+        /// </returns>
+        /// <exception cref="InvalidOperationException">
+        /// If the header is missing on <paramref name="reader"/> or <paramref name="options"/> indicating that header is absent.
+        /// </exception>
         public static IEnumerable<T> ReadRecords<T>(this
             TextReader reader,
             VariableLengthReaderOptions options,
-            bool skipMismatchedColumns = false,
+            bool skipUnmatchedColumns = true,
             Action<IVariableLengthReaderSequentialBuilder<T>> action = null)
         {
             string header;
@@ -71,7 +90,7 @@ public static IEnumerable<T> ReadRecords<T>(this
 
             var separator = DetectDelimiter(header.AsMemory());
             var columns = header.Split(separator);
-            var parser = BuildParser(columns, separator, skipMismatchedColumns, action);
+            var parser = BuildParser(columns, separator, skipUnmatchedColumns, action);
 
             return ReadRecords(reader, parser, options with { HasHeader = false });
         }