summaryrefslogtreecommitdiff
path: root/lib
diff options
context:
space:
mode:
authorzzak <zzak@b2dd03c8-39d4-4d8f-98ff-823fe69b080e>2012-11-14 02:53:02 +0000
committerzzak <zzak@b2dd03c8-39d4-4d8f-98ff-823fe69b080e>2012-11-14 02:53:02 +0000
commita4b0291fcb4bbb53c57fbaeaeb5b16d8aa63d5a7 (patch)
treec57291f479d252979085e1b57c07f7910f991937 /lib
parent5de3acdcd8943c10617c842d81f4c0cc27d6bf47 (diff)
* lib/csv.rb (init_comments): Document private method #init_comments.
Based on a patch from Vincent Batts [ruby-core:49172] [Bug #7319] git-svn-id: svn+ssh://ci.ruby-lang.org/ruby/trunk@37651 b2dd03c8-39d4-4d8f-98ff-823fe69b080e
Diffstat (limited to 'lib')
-rw-r--r--lib/csv.rb5
1 files changed, 5 insertions, 0 deletions
diff --git a/lib/csv.rb b/lib/csv.rb
index 5be4b0d347..58953a2bf9 100644
--- a/lib/csv.rb
+++ b/lib/csv.rb
@@ -2206,6 +2206,11 @@ class CSV
init_converters(options, :header_converters)
end
+ # Stores the pattern of comments to skip from the provided options.
+ #
+ # The pattern must respond to +.match+, else ArgumentError is raised.
+ #
+ # See also CSV.new
def init_comments(options)
@skip_lines = options.delete(:skip_lines)
if @skip_lines and not @skip_lines.respond_to?(:match)