lib/uri/file.rb in uri-0.11.2 vs lib/uri/file.rb in uri-0.12.0

@@ -31,19 +31,25 @@
     # with keys formed by preceding the component names with a colon.
     #
     # If an Array is used, the components must be passed in the
     # order <code>[host, path]</code>.
     #
+    # A path from e.g. the File class should be escaped before
+    # being passed.
+    #
     # Examples:
     #
     #     require 'uri'
     #
     #     uri1 = URI::File.build(['host.example.com', '/path/file.zip'])
     #     uri1.to_s  # => "file://host.example.com/path/file.zip"
     #
     #     uri2 = URI::File.build({:host => 'host.example.com',
     #       :path => '/ruby/src'})
     #     uri2.to_s  # => "file://host.example.com/ruby/src"
+    #
+    #     uri3 = URI::File.build({:path => URI::escape('/path/my file.txt')})
+    #     uri3.to_s  # => "file:///path/my%20file.txt"
     #
     def self.build(args)
       tmp = Util::make_components_hash(self, args)
       super(tmp)
     end