[DOC] Enhanced RDoc for URI (#55)

ruby · Jan 8, 2023 · 89ab4f1 · 89ab4f1
1 parent ce379e6
commit 89ab4f1
Showing 1 changed file with 9 additions and 1 deletion.
diff --git a/lib/uri/common.rb b/lib/uri/common.rb
@@ -829,7 +829,15 @@ def self.get_encoding(label)
 module Kernel
 
   #
-  # Returns +uri+ converted to an URI object.
+  # Returns a \URI object derived from the given +uri+,
+  # which may be a \URI string or an existing \URI object:
+  #
+  #   # Returns a new URI.
+  #   uri = URI('http://github.com/ruby/ruby')
+  #   # => #<URI::HTTP http://github.com/ruby/ruby>
+  #   # Returns the given URI.
+  #   URI(uri)
+  #   # => #<URI::HTTP http://github.com/ruby/ruby>
   #
   def URI(uri)
     if uri.is_a?(URI::Generic)