Skip to content

Commit 3323b8a

Browse files
committed
doc: clarify the meaning of legacy status
Fixes: nodejs#42230 Fixes: nodejs#42232 Signed-off-by: Darshan Sen <[email protected]>
1 parent dde2f78 commit 3323b8a

File tree

2 files changed

+10
-8
lines changed

2 files changed

+10
-8
lines changed

doc/api/documentation.md

+4-3
Original file line numberDiff line numberDiff line change
@@ -40,9 +40,10 @@ The stability indices are as follows:
4040
4141
<!-- separator -->
4242

43-
> Stability: 3 - Legacy. The feature is no longer recommended for use. While it
44-
> likely will not be removed, and is still covered by semantic-versioning
45-
> guarantees, use of the feature should be avoided.
43+
> Stability: 3 - Legacy. It is the same as a forever Documentation-only
44+
> deprecation. While it likely will not be removed, and is still
45+
> covered by semantic-versioning guarantees, use of the feature is no longer
46+
> recommended as it not officially supported by the project.
4647
4748
Use caution when making use of Experimental features, particularly within
4849
modules. Users may not be aware that experimental features are being used.

doc/api/url.md

+6-5
Original file line numberDiff line numberDiff line change
@@ -1558,11 +1558,12 @@ A `TypeError` is thrown if `urlString` is not a string.
15581558

15591559
A `URIError` is thrown if the `auth` property is present but cannot be decoded.
15601560

1561-
Use of the legacy `url.parse()` method is discouraged. Users should
1562-
use the WHATWG `URL` API. Because the `url.parse()` method uses a
1563-
lenient, non-standard algorithm for parsing URL strings, security
1564-
issues can be introduced. Specifically, issues with [host name spoofing][] and
1565-
incorrect handling of usernames and passwords have been identified.
1561+
Use of the legacy `url.parse()` method is not encouraged as it is not officially
1562+
supported by the project. Users are recommended to use the WHATWG `URL` API
1563+
instead. Because the `url.parse()` method uses a lenient, non-standard algorithm
1564+
for parsing URL strings, security issues can be introduced. Specifically, issues
1565+
with [host name spoofing][] and incorrect handling of usernames and passwords
1566+
have been identified.
15661567

15671568
### `url.resolve(from, to)`
15681569

0 commit comments

Comments
 (0)