Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

doc: clarify the meaning of legacy status #42269

7 changes: 4 additions & 3 deletions doc/api/documentation.md
Original file line number Diff line number Diff line change
Expand Up @@ -40,9 +40,10 @@ The stability indices are as follows:

<!-- separator -->

> Stability: 3 - Legacy. The feature is no longer recommended for use. While it
> likely will not be removed, and is still covered by semantic-versioning
> guarantees, use of the feature should be avoided.
> Stability: 3 - Legacy. It is the same as a forever Documentation-only
> deprecation. While it likely will not be removed, and is still
> covered by semantic-versioning guarantees, use of the feature is no longer
> recommended as it is not officially supported by the project.
RaisinTen marked this conversation as resolved.
Show resolved Hide resolved

Use caution when making use of Experimental features, particularly within
modules. Users may not be aware that experimental features are being used.
Expand Down
11 changes: 6 additions & 5 deletions doc/api/url.md
Original file line number Diff line number Diff line change
Expand Up @@ -1558,11 +1558,12 @@ A `TypeError` is thrown if `urlString` is not a string.

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

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

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

Expand Down