From ff3e943d1f0fa78736065bc00e314c1ba310c350 Mon Sep 17 00:00:00 2001 From: drbrain Date: Mon, 29 Nov 2010 20:23:59 +0000 Subject: Improve documentation for URI::Common#encode_www_form, OpenSSL::SSL::SSLContext#ssl_version=. Add documentation for OpenSSL::SSL::SSLContext#ciphers git-svn-id: svn+ssh://ci.ruby-lang.org/ruby/trunk@29977 b2dd03c8-39d4-4d8f-98ff-823fe69b080e --- lib/uri/common.rb | 21 ++++++++++++--------- 1 file changed, 12 insertions(+), 9 deletions(-) (limited to 'lib/uri') diff --git a/lib/uri/common.rb b/lib/uri/common.rb index 8cd2f2b069..b23e971f5e 100644 --- a/lib/uri/common.rb +++ b/lib/uri/common.rb @@ -733,10 +733,11 @@ module URI # Encode given +str+ to URL-encoded form data. # - # This doesn't convert *, -, ., 0-9, A-Z, _, a-z, - # does convert SP to +, and convert others to %XX. + # This method doesn't convert *, -, ., 0-9, A-Z, _, a-z, but does convert SP + # (ASCII space) to + and converts others to %XX. # - # This refers http://www.w3.org/TR/html5/forms.html#url-encoded-form-data + # This is an implementation of + # http://www.w3.org/TR/html5/forms.html#url-encoded-form-data # # See URI.decode_www_form_component, URI.encode_www_form def self.encode_www_form_component(str) @@ -786,14 +787,16 @@ module URI # # This internally uses URI.encode_www_form_component(str). # - # This doesn't convert encodings of give items, so convert them before call - # this method if you want to send data as other than original encoding or - # mixed encoding data. (strings which is encoded in HTML5 ASCII incompatible - # encoding is converted to UTF-8) + # This method doesn't convert the encoding of given items, so convert them + # before call this method if you want to send data as other than original + # encoding or mixed encoding data. (Strings which are encoded in an HTML5 + # ASCII incompatible encoding are converted to UTF-8.) # - # This doesn't treat files. When you send a file, use multipart/form-data. + # This method doesn't handle files. When you send a file, use + # multipart/form-data. # - # This refers http://www.w3.org/TR/html5/forms.html#url-encoded-form-data + # This is an implementation of + # http://www.w3.org/TR/html5/forms.html#url-encoded-form-data # # See URI.encode_www_form_component, URI.decode_www_form def self.encode_www_form(enum) -- cgit v1.2.3