summaryrefslogtreecommitdiff
path: root/lib
diff options
context:
space:
mode:
authorhsbt <hsbt@b2dd03c8-39d4-4d8f-98ff-823fe69b080e>2014-11-04 03:21:50 +0000
committerhsbt <hsbt@b2dd03c8-39d4-4d8f-98ff-823fe69b080e>2014-11-04 03:21:50 +0000
commit934789941e6f57892ae91a85778672ef883f61be (patch)
treed4b3deba4b90416d052ea0d10305bbfa1d8314d9 /lib
parent91dd80fac707002c99ba6db4ee79cf85e1186cb8 (diff)
* lib/csv.rb: added documentation for skip_blanks option by @decasia
[fix GH-744][ci skip] git-svn-id: svn+ssh://ci.ruby-lang.org/ruby/trunk@48258 b2dd03c8-39d4-4d8f-98ff-823fe69b080e
Diffstat (limited to 'lib')
-rw-r--r--lib/csv.rb10
1 files changed, 9 insertions, 1 deletions
diff --git a/lib/csv.rb b/lib/csv.rb
index c56f11bcf4..cc3e7f6362 100644
--- a/lib/csv.rb
+++ b/lib/csv.rb
@@ -1470,7 +1470,15 @@ class CSV
# if the data cannot be transcoded,
# leaving the header unchanged.
# <b><tt>:skip_blanks</tt></b>:: When set to a +true+ value, CSV will
- # skip over any rows with no content.
+ # skip over any empty rows. Note that
+ # this setting will not skip rows that
+ # contain column separators, even if
+ # the rows contain no actual data. If
+ # you want to skip rows that contain
+ # separators but no content, consider
+ # using <tt>:skip_lines</tt>, or
+ # inspecting fields.compact.empty? on
+ # each row.
# <b><tt>:force_quotes</tt></b>:: When set to a +true+ value, CSV will
# quote all CSV fields it creates.
# <b><tt>:skip_lines</tt></b>:: When set to an object responding to