mirror of
https://github.com/ruby/ruby.git
synced 2022-11-09 12:17:21 -05:00
[ruby/csv] doc: fix return value of open {} and use File.open {} (#139)
* Enhanced RDoc for CSV * Repair example code for foreach https://github.com/ruby/csv/commit/16b425eb37
This commit is contained in:
parent
7c55c96147
commit
013cca1f9a
Notes:
git
2020-07-20 03:35:38 +09:00
1 changed files with 8 additions and 4 deletions
12
lib/csv.rb
12
lib/csv.rb
|
@ -863,7 +863,10 @@ class CSV
|
|||
# ["baz", "2"]
|
||||
#
|
||||
# Read rows from an \IO object:
|
||||
# CSV.foreach(File.open(path)) {|row| p row } # => 21
|
||||
# File.open(path) do |file|
|
||||
# CSV.foreach(file) {|row| p row } # => 21
|
||||
# end
|
||||
#
|
||||
# Output:
|
||||
# ["foo", "0"]
|
||||
# ["bar", "1"]
|
||||
|
@ -1023,8 +1026,8 @@ class CSV
|
|||
# :call-seq:
|
||||
# open(file_path, mode = "rb", **options ) -> new_csv
|
||||
# open(io, mode = "rb", **options ) -> new_csv
|
||||
# open(file_path, mode = "rb", **options ) { |csv| ... } -> new_csv
|
||||
# open(io, mode = "rb", **options ) { |csv| ... } -> new_csv
|
||||
# open(file_path, mode = "rb", **options ) { |csv| ... } -> object
|
||||
# open(io, mode = "rb", **options ) { |csv| ... } -> object
|
||||
#
|
||||
# possible options elements:
|
||||
# hash form:
|
||||
|
@ -1071,7 +1074,8 @@ class CSV
|
|||
#
|
||||
# ---
|
||||
#
|
||||
# With a block given, calls the block with the created \CSV object:
|
||||
# With a block given, calls the block with the created \CSV object;
|
||||
# returns the block's return value:
|
||||
#
|
||||
# Using a file path:
|
||||
# csv = CSV.open(path) {|csv| p csv}
|
||||
|
|
Loading…
Reference in a new issue