[ruby-core:58436] [ruby-trunk - Bug #9127] URI::Generic#normalize documentation is vague.

Issue #9127 has been updated by nagachika (Tomoyuki Chikanaga).

Category set to doc
ruby -v set to -


----------------------------------------
Bug #9127: URI::Generic#normalize documentation is vague.
https://bugs.ruby-lang.org/issues/9127#change-43035

Author: robertgleeson (Robert Gleeson)
Status: Open
Priority: Low
Assignee: 
Category: doc
Target version: 
ruby -v: -
Backport: 


the documentation for `URI::Generic#normalize` is vague and does not provide enough details about the algorithm that applies normalization.
the documentation says, "Returns normalized URI" and nothing more. I would have expected a short piece that explains how normalization
is applied.

pry session attached (ruby = v2.0.0)

$ pry
[1] pry(main)> require "uri"
=> true

[2] pry(main)> uri = URI.parse("http://www.ruby-lang.org")
=> #<URI::HTTP:0x007f974549f5a0 URL:http://www.ruby-lang.org>

[3] pry(main)> ? uri.normalize
From: /Users/robert/.rubies/ruby-2.0.0-p247/lib/ruby/2.0.0/uri/generic.rb @ line 1418:
Owner: URI::Generic
Visibility: public
Signature: normalize()
Number of lines: 2

Returns normalized URI


-- 
http://bugs.ruby-lang.org/