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] doc: fix return value of open {} and use File.open {} (#139)

Browse source 
* Enhanced RDoc for CSV

* Repair example code for foreach
https://github.com/ruby/csv/commit/16b425eb37
This commit is contained in:
Burdette Lamar 2020-06-14 19:09:58 -05:00 committed by Nobuyoshi Nakada
parent 7c55c96147
commit 013cca1f9a
No known key found for this signature in database
GPG key ID: 7CD2805BFA3770C6
Notes: git 2020-07-20 03:35:38 +09:00 
Merged: https://github.com/ruby/ruby/pull/3332
1 changed files with 8 additions and 4 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

12
lib/csv.rb
View file

@ -863,7 +863,10 @@ class CSV
# ["baz", "2"] # ["baz", "2"]
# #
# Read rows from an \IO object: # 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: # Output:
# ["foo", "0"] # ["foo", "0"]
# ["bar", "1"] # ["bar", "1"]
@ -1023,8 +1026,8 @@ class CSV
# :call-seq: # :call-seq:
# open(file_path, mode = "rb", **options ) -> new_csv # open(file_path, mode = "rb", **options ) -> new_csv
# open(io, mode = "rb", **options ) -> new_csv # open(io, mode = "rb", **options ) -> new_csv
# open(file_path, mode = "rb", **options ) { |csv| ... } -> new_csv # open(file_path, mode = "rb", **options ) { |csv| ... } -> object
# open(io, mode = "rb", **options ) { |csv| ... } -> new_csv # open(io, mode = "rb", **options ) { |csv| ... } -> object
# #
# possible options elements: # possible options elements:
# hash form: # 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: # Using a file path:
# csv = CSV.open(path) {|csv| p csv} # csv = CSV.open(path) {|csv| p csv}