summaryrefslogtreecommitdiff
path: root/lib/uri/http.rb
diff options
context:
space:
mode:
authorstomar <stomar@b2dd03c8-39d4-4d8f-98ff-823fe69b080e>2018-04-21 20:04:05 +0000
committerstomar <stomar@b2dd03c8-39d4-4d8f-98ff-823fe69b080e>2018-04-21 20:04:05 +0000
commit300b22dc225ece93394dafab231aae49ba12932f (patch)
treee4cb5b9cc0c652e4167135e842504ed6ceca6850 /lib/uri/http.rb
parentc04881f94a1f9f00867f742481e097c4ce8f952a (diff)
Improve docs for URI library
* lib/uri/generic.rb: [DOC] fix invalid example code to make it syntax highlighted; drop unnecessary `puts', `p'; adapt to current inspect format without Object id; do not display unnecessary return values in examples; fix or prevent unintended description lists; fix broken RDoc; fix grammar and typos. * lib/uri.rb: ditto. * lib/uri/common.rb: ditto. * lib/uri/file.rb: ditto. * lib/uri/ftp.rb: ditto. * lib/uri/http.rb: ditto. * lib/uri/ldap.rb: ditto. * lib/uri/mailto.rb: ditto. * lib/uri/rfc2396_parser.rb: ditto. git-svn-id: svn+ssh://ci.ruby-lang.org/ruby/trunk@63228 b2dd03c8-39d4-4d8f-98ff-823fe69b080e
Diffstat (limited to 'lib/uri/http.rb')
-rw-r--r--lib/uri/http.rb20
1 files changed, 10 insertions, 10 deletions
diff --git a/lib/uri/http.rb b/lib/uri/http.rb
index 0af1858efe2..7d499f08d86 100644
--- a/lib/uri/http.rb
+++ b/lib/uri/http.rb
@@ -21,10 +21,10 @@ module URI
# update. See <URL:http://support.microsoft.com/kb/834489>.
#
class HTTP < Generic
- # A Default port of 80 for URI::HTTP
+ # A Default port of 80 for URI::HTTP.
DEFAULT_PORT = 80
- # An Array of the available components for URI::HTTP
+ # An Array of the available components for URI::HTTP.
COMPONENT = %i[
scheme
userinfo host port
@@ -36,22 +36,22 @@ module URI
#
# == Description
#
- # Create a new URI::HTTP object from components, with syntax checking.
+ # Creates a new URI::HTTP object from components, with syntax checking.
#
- # The components accepted are userinfo, host, port, path, query and
+ # The components accepted are userinfo, host, port, path, query, and
# fragment.
#
# The components should be provided either as an Array, or as a Hash
# with keys formed by preceding the component names with a colon.
#
- # If an Array is used, the components must be passed in the order
- # [userinfo, host, port, path, query, fragment].
+ # If an Array is used, the components must be passed in the
+ # order <code>[userinfo, host, port, path, query, fragment]</code>.
#
# Example:
#
- # newuri = URI::HTTP.build(host: 'www.example.com', path: '/foo/bar')
+ # uri = URI::HTTP.build(host: 'www.example.com', path: '/foo/bar')
#
- # newuri = URI::HTTP.build([nil, "www.example.com", nil, "/path",
+ # uri = URI::HTTP.build([nil, "www.example.com", nil, "/path",
# "query", 'fragment'])
#
# Currently, if passed userinfo components this method generates
@@ -72,8 +72,8 @@ module URI
#
# Example:
#
- # newuri = URI::HTTP.build(path: '/foo/bar', query: 'test=true')
- # newuri.request_uri # => "/foo/bar?test=true"
+ # uri = URI::HTTP.build(path: '/foo/bar', query: 'test=true')
+ # uri.request_uri # => "/foo/bar?test=true"
#
def request_uri
return unless @path