kotovalexarian-likes-github/ruby--ruby
1
0
Fork 0
mirror of https://github.com/ruby/ruby.git synced 2022-11-09 12:17:21 -05:00
Code Releases Activity

[ruby/csv] Added headers to RDoc for CSV.foreach (#142)

Browse source 
* Added headers: to RDoc for CSV.foreach

* Correct options remark for CSV.generate

* Improve citation for option headers
https://github.com/ruby/csv/commit/b01945ec3a
This commit is contained in:
Burdette Lamar 2020-06-18 15:21:37 -05:00 • committed by Nobuyoshi Nakada
parent e4742fec64
commit 6106b7badd
No known key found for this signature in database
GPG key ID: 7CD2805BFA3770C6
Notes: git 2020-07-20 03:35:37 +09:00
1 changed files with 44 additions and 7 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

51
lib/csv.rb
View file

@ -825,6 +825,8 @@ class CSV
# :call-seq:
# foreach(path, mode='r', **options) {|row| ... ) -> integer or nil
# foreach(io, mode='r', **options {|row| ... ) -> integer or nil
# foreach(path, mode='r', headers: ..., **options) {|row| ... ) -> integer or nil
# foreach(io, mode='r', headers: ..., **options {|row| ... ) -> integer or nil
# foreach(path, mode='r', **options) -> new_enumerator
# foreach(io, mode='r', **options -> new_enumerator
#
@ -848,7 +850,9 @@ class CSV
# would read +UTF-32BE+ data from the file
# but transcode it to +UTF-8+ before parsing.
#
# ---
# ====== Without Option +headers+
#
# Without option +headers+, returns each row as an \Array object.
#
# These examples assume prior execution of:
# string = "foo,0\nbar,1\nbaz,2\n"
@ -882,6 +886,34 @@ class CSV
# warning: Unsupported encoding foo ignored
# warning: Unsupported encoding bar ignored
#
# ====== With Option +headers+
#
# With {option +headers+}[#class-CSV-label-Option+headers],
# returns each row as a CSV::Row object.
#
# These examples assume prior execution of:
# string = "Name,Count\nfoo,0\nbar,1\nbaz,2\n"
# path = 't.csv'
# File.write(path, string)
#
# Read rows from a file at +path+:
# CSV.foreach(path, headers: true) {|row| p row } # => 21
#
# Output:
# #<CSV::Row "Name":"foo" "Count":"0">
# #<CSV::Row "Name":"bar" "Count":"1">
# #<CSV::Row "Name":"baz" "Count":"2">
#
# Read rows from an \IO object:
# File.open(path) do |file|
# CSV.foreach(file, headers: true) {|row| p row } # => 21
# end
#
# Output:
# #<CSV::Row "Name":"foo" "Count":"0">
# #<CSV::Row "Name":"bar" "Count":"1">
# #<CSV::Row "Name":"baz" "Count":"2">
#
# ---
#
# Raises an exception if +path+ is a \String, but not the path to a readable file:
@ -911,8 +943,8 @@ class CSV
#
# * Argument +csv_string+, if given, must be a \String object;
# defaults to a new empty \String.
# * Arguments +options+, if given, should be parsing options.
# See {Options for Parsing}[#class-CSV-label-Options+for+Parsing].
# * Arguments +options+, if given, should be generating options.
# See {Options for Generating}[#class-CSV-label-Options+for+Generating].
#
# ---
#
@ -1145,15 +1177,15 @@ class CSV
# :include: ../doc/argument_io.rdoc
# - Argument +options+: see {Options for Parsing}[#class-CSV-label-Options+for+Parsing]
#
# ====== Without Option +headers+
#
# Without option +headers+, returns an \Array of Arrays or an integer.
#
# These examples assume prior execution of:
# string = "foo,0\nbar,1\nbaz,2\n"
# path = 't.csv'
# File.write(path, string)
#
# ====== Without Option +headers+
#
# Without option +headers+, returns an \Array of Arrays or an integer.
#
# ---
#
# With no block given, returns an \Array of Arrays formed from the source.
@ -1195,6 +1227,11 @@ class CSV
# With {option +headers+}[#class-CSV-label-Option+headers],
# returns a new CSV::Table object or an integer.
#
# These examples assume prior execution of:
# string = "Name,Count\nfoo,0\nbar,1\nbaz,2\n"
# path = 't.csv'
# File.write(path, string)
#
# ---
#
# With no block given, returns a CSV::Table object formed from the source.