summaryrefslogtreecommitdiff
path: root/doc/csv/options/parsing/nil_value.rdoc
diff options
context:
space:
mode:
Diffstat (limited to 'doc/csv/options/parsing/nil_value.rdoc')
-rw-r--r--doc/csv/options/parsing/nil_value.rdoc12
1 files changed, 12 insertions, 0 deletions
diff --git a/doc/csv/options/parsing/nil_value.rdoc b/doc/csv/options/parsing/nil_value.rdoc
new file mode 100644
index 0000000000..412e8795e8
--- /dev/null
+++ b/doc/csv/options/parsing/nil_value.rdoc
@@ -0,0 +1,12 @@
+====== Option +nil_value+
+
+Specifies the object that is to be substituted for each null (no-text) field.
+
+Default value:
+ CSV::DEFAULT_OPTIONS.fetch(:nil_value) # => nil
+
+With the default, +nil+:
+ CSV.parse_line('a,,b,,c') # => ["a", nil, "b", nil, "c"]
+
+With a different object:
+ CSV.parse_line('a,,b,,c', nil_value: 0) # => ["a", 0, "b", 0, "c"]