From a4b0291fcb4bbb53c57fbaeaeb5b16d8aa63d5a7 Mon Sep 17 00:00:00 2001
From: zzak <zzak@b2dd03c8-39d4-4d8f-98ff-823fe69b080e>
Date: Wed, 14 Nov 2012 02:53:02 +0000
Subject: * 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
---
 lib/csv.rb | 5 +++++
 1 file changed, 5 insertions(+)

(limited to 'lib')

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)
-- 
cgit v1.2.3