summaryrefslogtreecommitdiff
path: root/doc/csv/write_headers.rdoc
blob: f9faa9d43827c268602aa2323fdfbdf9cbb926a0 (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
====== Option +write_headers+

Specifies the boolean that determines whether a header row is included in the output;
ignored if there are no headers.

Default value:
  CSV::DEFAULT_OPTIONS.fetch(:write_headers) # => nil

Without +write_headers+:
  file_path = 't.csv'
  CSV.open(file_path,'w',
      :headers => ['Name','Value']
    ) do |csv|
      csv << ['foo', '0']
  end
  CSV.open(file_path) do |csv|
    csv.shift
  end # => ["foo", "0"]

With +write_headers+":
  CSV.open(file_path,'w',
      :write_headers=> true,
      :headers => ['Name','Value']
    ) do |csv|
      csv << ['foo', '0']
  end
  CSV.open(file_path) do |csv|
    csv.shift
  end # => ["Name", "Value"]