summaryrefslogtreecommitdiff
path: root/doc/csv/force_quotes.rdoc
diff options
context:
space:
mode:
Diffstat (limited to 'doc/csv/force_quotes.rdoc')
-rw-r--r--doc/csv/force_quotes.rdoc17
1 files changed, 17 insertions, 0 deletions
diff --git a/doc/csv/force_quotes.rdoc b/doc/csv/force_quotes.rdoc
new file mode 100644
index 0000000000..11afd1a16c
--- /dev/null
+++ b/doc/csv/force_quotes.rdoc
@@ -0,0 +1,17 @@
+====== Option +force_quotes+
+
+Specifies the boolean that determines whether each output field is to be double-quoted.
+
+Default value:
+ CSV::DEFAULT_OPTIONS.fetch(:force_quotes) # => false
+
+For examples in this section:
+ ary = ['foo', 0, nil]
+
+Using the default, +false+:
+ str = CSV.generate_line(ary)
+ str # => "foo,0,\n"
+
+Using +true+:
+ str = CSV.generate_line(ary, force_quotes: true)
+ str # => "\"foo\",\"0\",\"\"\n"