[前][次][番号順一覧][スレッド一覧]

ruby-changes:62299

From: Burdette <ko1@a...>
Date: Mon, 20 Jul 2020 03:35:53 +0900 (JST)
Subject: [ruby-changes:62299] 013cca1f9a (master): [ruby/csv] doc: fix return value of open {} and use File.open {} (#139)

https://git.ruby-lang.org/ruby.git/commit/?id=013cca1f9a

From 013cca1f9a87eebba61e11ebcf97109dde009d37 Mon Sep 17 00:00:00 2001
From: Burdette Lamar <BurdetteLamar@Y...>
Date: Sun, 14 Jun 2020 19:09:58 -0500
Subject: [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

diff --git a/lib/csv.rb b/lib/csv.rb
index 65f31a6..35921db 100644
--- a/lib/csv.rb
+++ b/lib/csv.rb
@@ -863,7 +863,10 @@ class CSV https://github.com/ruby/ruby/blob/trunk/lib/csv.rb#L863
     #   ["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 https://github.com/ruby/ruby/blob/trunk/lib/csv.rb#L1026
     # :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 https://github.com/ruby/ruby/blob/trunk/lib/csv.rb#L1074
     #
     # ---
     #
-    # 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}
-- 
cgit v0.10.2


--
ML: ruby-changes@q...
Info: http://www.atdot.net/~ko1/quickml/

[前][次][番号順一覧][スレッド一覧]