From f1768445b697de6069b85d8552debc7ee0b4fa70 Mon Sep 17 00:00:00 2001 From: Isaac Levy Date: Sun, 3 Jan 2021 16:11:29 -0500 Subject: [PATCH 1/2] docs: Add references to punycode.md Add references to related `url` functions in punycode.md. These provide guidance to users who may be investigating the punycode module for URL encoding. --- doc/api/punycode.md | 6 +++++- 1 file changed, 5 insertions(+), 1 deletion(-) diff --git a/doc/api/punycode.md b/doc/api/punycode.md index 620585afa484c1..876b4ffcc00673 100644 --- a/doc/api/punycode.md +++ b/doc/api/punycode.md @@ -12,7 +12,9 @@ deprecated: v7.0.0 **The version of the punycode module bundled in Node.js is being deprecated**. In a future major version of Node.js this module will be removed. Users currently depending on the `punycode` module should switch to using the -userland-provided [Punycode.js][] module instead. +userland-provided [Punycode.js][] module instead. For punycode-based URL +encoding, see [`url.domainToASCII`][] or, more generally, the +[WHATWG URL API][]. The `punycode` module is a bundled version of the [Punycode.js][] module. It can be accessed using: @@ -150,3 +152,5 @@ Returns a string identifying the current [Punycode.js][] version number. [Punycode]: https://tools.ietf.org/html/rfc3492 [Punycode.js]: https://github.com/bestiejs/punycode.js +[WHATWG URL API]: url.md#the-whatwg-url-api +[`url.domainToASCII`]: url.md#urldomaintoasciidomain From 39204a2f0bea140db3a812d15db7afc58bfda084 Mon Sep 17 00:00:00 2001 From: Isaac Levy Date: Mon, 4 Jan 2021 07:02:44 -0500 Subject: [PATCH 2/2] docs: fix links for ci Co-authored-by: Antoine du Hamel --- doc/api/punycode.md | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/doc/api/punycode.md b/doc/api/punycode.md index 876b4ffcc00673..c9c20ce6350c7e 100644 --- a/doc/api/punycode.md +++ b/doc/api/punycode.md @@ -152,5 +152,5 @@ Returns a string identifying the current [Punycode.js][] version number. [Punycode]: https://tools.ietf.org/html/rfc3492 [Punycode.js]: https://github.com/bestiejs/punycode.js -[WHATWG URL API]: url.md#the-whatwg-url-api -[`url.domainToASCII`]: url.md#urldomaintoasciidomain +[WHATWG URL API]: url.md#url_the_whatwg_url_api +[`url.domainToASCII`]: url.md#url_url_domaintoascii_domain