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