summaryrefslogtreecommitdiff
path: root/doc/csv/options/generating/write_nil_value.rdoc
diff options
context:
space:
mode:
Diffstat (limited to 'doc/csv/options/generating/write_nil_value.rdoc')
-rw-r--r--doc/csv/options/generating/write_nil_value.rdoc14
1 files changed, 14 insertions, 0 deletions
diff --git a/doc/csv/options/generating/write_nil_value.rdoc b/doc/csv/options/generating/write_nil_value.rdoc
new file mode 100644
index 0000000000..8560f644b3
--- /dev/null
+++ b/doc/csv/options/generating/write_nil_value.rdoc
@@ -0,0 +1,14 @@
+====== Option +write_nil_value+
+
+Specifies the object that is to be substituted for each +nil+ field.
+
+Default value:
+ CSV::DEFAULT_OPTIONS.fetch(:write_nil_value) # => nil
+
+Without the option:
+ str = CSV.generate_line(['a', nil, 'c', nil])
+ str # => "a,,c,\n"
+
+With the option:
+ str = CSV.generate_line(['a', nil, 'c', nil], write_nil_value: "x")
+ str # => "a,x,c,x\n"