aboutsummaryrefslogtreecommitdiffstats
path: root/doc/csv/empty_value.rdoc
diff options
context:
space:
mode:
authorBurdette Lamar <BurdetteLamar@Yahoo.com>2020-05-12 16:42:45 -0500
committerNobuyoshi Nakada <nobu@ruby-lang.org>2020-07-20 02:32:50 +0900
commit6ba1abd40c4610506a638246431660a32a9b1798 (patch)
treeb680025fca57f8aa0e1cece9cb7568d53af91400 /doc/csv/empty_value.rdoc
parent033514c62fef937dda904daa3b73b2b9750913f0 (diff)
downloadruby-6ba1abd40c4610506a638246431660a32a9b1798.tar.gz
[ruby/csv] Enhanced Rdoc for CSV (#122)
https://github.com/ruby/csv/commit/cd670595d5
Diffstat (limited to 'doc/csv/empty_value.rdoc')
-rw-r--r--doc/csv/empty_value.rdoc13
1 files changed, 13 insertions, 0 deletions
diff --git a/doc/csv/empty_value.rdoc b/doc/csv/empty_value.rdoc
new file mode 100644
index 0000000000..7d3bcc078c
--- /dev/null
+++ b/doc/csv/empty_value.rdoc
@@ -0,0 +1,13 @@
+====== Option +empty_value+
+
+Specifies the object that is to be substituted
+for each field that has an empty \String.
+
+Default value:
+ CSV::DEFAULT_OPTIONS.fetch(:empty_value) # => "" (empty string)
+
+With the default, <tt>""</tt>:
+ CSV.parse_line('a,"",b,"",c') # => ["a", "", "b", "", "c"]
+
+With a different object:
+ CSV.parse_line('a,"",b,"",c', empty_value: 'x') # => ["a", "x", "b", "x", "c"]