Discourage the use of old modules for dealing with URLs

yast · Jul 26, 2021 · 6cc3fa9 · 6cc3fa9
1 parent d018814
commit 6cc3fa9
Show file tree

Hide file tree

Showing 2 changed files with 13 additions and 0 deletions.
diff --git a/library/types/src/modules/URL.rb b/library/types/src/modules/URL.rb
@@ -30,6 +30,13 @@
 require "yast"
 
 module Yast
+  # A module for dealing with URLs
+  #
+  # @note This is legacy code ported from the
+  # {https://news.opensuse.org/2007/08/29/yast-independence-of-ycp/ YCP} era. Its use is highly
+  # discouraged in favor of the {https://ruby-doc.org/stdlib-3.0.2/libdoc/uri/rdoc/URI.html URI}
+  # standard library or the new {Y2Packager::ZyppUrl} (available from SLE-15-SP3 on) when working
+  # with libzypp URLs.
   class URLClass < Module
     def main
       textdomain "base"

diff --git a/library/types/src/modules/URLRecode.rb b/library/types/src/modules/URLRecode.rb
@@ -4,6 +4,12 @@
 
 module Yast
   # A drop-in replacement of an earlier Perl implementation
+  #
+  # @note This is legacy code ported from the
+  # {https://news.opensuse.org/2007/08/29/yast-independence-of-ycp/ YCP} era. Its use is highly
+  # discouraged in favor of the {https://ruby-doc.org/stdlib-3.0.2/libdoc/uri/rdoc/URI.html URI}
+  # standard library or the new {Y2Packager::ZyppUrl} (available from SLE-15-SP3 on) when working
+  # with libzypp URLs.
   class URLRecodeClass < Module
     # these will be substituted to a regex character class
     USERNAME_PASSWORD_FRAGMENT_SAFE_CHARS = "-A-Za-z0-9_.!~*'()".freeze