Project

General

Profile

Bug #9127

URI::Generic#normalize documentation is vague.

Added by robertgleeson (Robert Gleeson) about 4 years ago. Updated 9 months ago.

Status:
Closed
Priority:
Normal
Target version:
ruby -v:
-
Backport:
[ruby-core:58430]

Description

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")
=> #

[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

Associated revisions

Revision 58023
Added by stomar (Marcus Stollsteimer) 9 months ago

improve docs for URI::Generic

  • lib/uri/generic.rb: [DOC] expand docs for URI::Generic#normalize
    to clarify what normalization means here.
    Reported by Robert Gleeson. [Bug #9127]

  • lib/uri/generic.rb: [DOC] fix indent for correct code block detection.

History

#1 Updated by nagachika (Tomoyuki Chikanaga) about 4 years ago

  • Tracker changed from Backport to Bug
  • Project changed from Backport200 to Ruby trunk

#2 [ruby-core:58436] Updated by nagachika (Tomoyuki Chikanaga) about 4 years ago

  • Category set to doc
  • ruby -v set to -

#3 [ruby-core:60853] Updated by zzak (Zachary Scott) almost 4 years ago

  • Status changed from Open to Assigned
  • Assignee set to zzak (Zachary Scott)
  • Target version set to 2.2.0

#4 Updated by stomar (Marcus Stollsteimer) 9 months ago

  • Status changed from Assigned to Closed

Applied in changeset r58023.


improve docs for URI::Generic

  • lib/uri/generic.rb: [DOC] expand docs for URI::Generic#normalize
    to clarify what normalization means here.
    Reported by Robert Gleeson. [Bug #9127]

  • lib/uri/generic.rb: [DOC] fix indent for correct code block detection.

Also available in: Atom PDF