Project

General

Profile

Actions

Misc #11960

closed

Tiny documentation improvement for URI.escape

Added by meta (mathew murphy) almost 6 years ago. Updated about 5 years ago.

Status:
Closed
Priority:
Normal
[ruby-core:72733]

Description

This just cropped up on Reddit. A user was confused by URI.escape's behavior, why it was obsolete, and what should be used instead. So, here's a trivial doc patch:

diff --git a/lib/uri/common.rb b/lib/uri/common.rb
index 4c7d112..e139499 100644
--- a/lib/uri/common.rb
+++ b/lib/uri/common.rb
@@ -81,6 +81,10 @@ module Escape
     #
     # Escapes the string, replacing all unsafe characters with codes.
     #
+    # This method is obsolete and should not be used. Instead, use
+    # CGI.escape, URI.www_form_encode or URI.www_form_encode_component
+    # depending on your specific use case.
+    #
     # == Usage
     #
     #   require 'uri'
Actions

Also available in: Atom PDF