kotovalexarian-likes-github/ruby--ruby
1
0
Fork 0
mirror of https://github.com/ruby/ruby.git synced 2022-11-09 12:17:21 -05:00
Code Releases Activity

Improve docs for URI library

Browse source 
* 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
This commit is contained in:
stomar 2018-04-21 20:04:05 +00:00
parent c04881f94a
commit 300b22dc22
9 changed files with 343 additions and 372 deletions
Download patch file Download diff file Expand all files Collapse all files

20
lib/uri/http.rb
View file

@ -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