aboutsummaryrefslogtreecommitdiffstats
path: root/lib/csv/fields_converter.rb
diff options
context:
space:
mode:
Diffstat (limited to 'lib/csv/fields_converter.rb')
-rw-r--r--lib/csv/fields_converter.rb6
1 files changed, 6 insertions, 0 deletions
diff --git a/lib/csv/fields_converter.rb b/lib/csv/fields_converter.rb
index c2fa5798ff..a751c9ea1d 100644
--- a/lib/csv/fields_converter.rb
+++ b/lib/csv/fields_converter.rb
@@ -1,8 +1,14 @@
# frozen_string_literal: true
class CSV
+ # Note: Don't use this class directly. This is an internal class.
class FieldsConverter
include Enumerable
+ #
+ # A CSV::FieldsConverter is a data structure for storing the
+ # fields converter properties to be passed as a parameter
+ # when parsing a new file (e.g. CSV::Parser.new(@io, parser_options))
+ #
def initialize(options={})
@converters = []