aboutsummaryrefslogtreecommitdiffstats
path: root/lib
diff options
context:
space:
mode:
authornobu <nobu@b2dd03c8-39d4-4d8f-98ff-823fe69b080e>2016-01-23 02:30:07 +0000
committernobu <nobu@b2dd03c8-39d4-4d8f-98ff-823fe69b080e>2016-01-23 02:30:07 +0000
commitba5a40fe7d97a24af49ce4b2f9bf397187e05ff7 (patch)
tree7a63855201b79ff688ec6b01c6cb7b743b4be4d0 /lib
parentac55501368ed29222f78b2660222fe45d05cde35 (diff)
downloadruby-ba5a40fe7d97a24af49ce4b2f9bf397187e05ff7.tar.gz
Update documentation of CSV header converter
* lib/csv.rb: Update documentation of CSV header converter for r45498, [GH-575]. [Fix GH-1215] git-svn-id: svn+ssh://ci.ruby-lang.org/ruby/trunk@53628 b2dd03c8-39d4-4d8f-98ff-823fe69b080e
Diffstat (limited to 'lib')
-rw-r--r--lib/csv.rb7
1 files changed, 4 insertions, 3 deletions
diff --git a/lib/csv.rb b/lib/csv.rb
index cd2d579b58..509e9780fa 100644
--- a/lib/csv.rb
+++ b/lib/csv.rb
@@ -982,9 +982,10 @@ class CSV
# through the +options+ Hash passed to CSV::new().
#
# <b><tt>:downcase</tt></b>:: Calls downcase() on the header String.
- # <b><tt>:symbol</tt></b>:: The header String is downcased, spaces are
- # replaced with underscores, non-word characters
- # are dropped, and finally to_sym() is called.
+ # <b><tt>:symbol</tt></b>:: Leading/trailing spaces are dropped, string is
+ # downcased, remaining spaces are replaced with
+ # underscores, non-word characters are dropped,
+ # and finally to_sym() is called.
#
# All built-in header converters transcode header data to UTF-8 before
# attempting a conversion. If your data cannot be transcoded to UTF-8 the