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.

Sign up for GitHub

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

Jump to bottom

doc: harmonize version pattern in YAML comments #35575

Merged
merged 1 commit into from Oct 13, 2020
+17 −8
Merged

doc: harmonize version pattern in YAML comments #35575

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Jump to
Jump to file
Failed to load files.
Diff view
Diff view
2 changes: 1 addition & 1 deletion doc/api/buffer.md
View file
Open in desktop
Expand Up @@ -2795,7 +2795,7 @@ added: v0.5.5
changes:
- version:
- v14.9.0
- 12.19.0
- v12.19.0
pr-url: https://github.com/nodejs/node/pull/34729
description: This function is also available as `buf.writeUint16LE()`.
- version: v10.0.0
Expand Down
11 changes: 8 additions & 3 deletions doc/api/deprecations.md
View file
Open in desktop
Expand Up @@ -729,7 +729,7 @@ changes:
pr-url: https://github.com/nodejs/node/pull/10116
description: A deprecation code has been assigned.
- version: v1.0.0
pr-url: https://github.com/iojs/io.js/pull/166
pr-url: https://github.com/nodejs/node/pull/166
description: Documentation-only deprecation.
-->

Expand Down Expand Up @@ -2143,6 +2143,9 @@ The `crypto._toBuf()` function was not designed to be used by modules outside
of Node.js core and was removed.

### DEP0115: `crypto.prng()`, `crypto.pseudoRandomBytes()`, `crypto.rng()`

<!--lint disable nodejs-yaml-comments -->
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Should the dual pr-url be allowed in the future, or better to ignore the one-off?

Copy link
Contributor Author

@aduh95 aduh95 Oct 10, 2020 •
edited

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I think that's a one off, we can revisite later if it becomes more common.


<!-- YAML
changes:
- version: v11.0.0
Expand All @@ -2153,6 +2156,8 @@ changes:
with `--pending-deprecation` support.
-->

<!--lint enable nodejs-yaml-comments -->

Type: Documentation-only (supports [`--pending-deprecation`][])

In recent versions of Node.js, there is no difference between
Expand Down Expand Up @@ -2531,8 +2536,8 @@ purpose and is only available on CommonJS environment.
<!-- YAML
changes:
- version:
- v12.19.0
- v14.0.0
- v12.19.0
pr-url: https://github.com/nodejs/node/pull/32499
description: Documentation-only deprecation.
-->
Expand Down Expand Up @@ -2658,7 +2663,7 @@ The [`crypto.Certificate()` constructor][] is deprecated. Use
### DEP0XXX: `fs.rmdir(path, { recursive: true })`
<!-- YAML
changes:
- version: REPLACME
- version: REPLACEME
pr-url: https://github.com/nodejs/node/pull/35579
description: Documentation-only deprecation.
-->
Expand Down
3 changes: 2 additions & 1 deletion doc/api/errors.md
View file
Open in desktop
Expand Up @@ -2396,7 +2396,8 @@ changes:
- version:
- v11.4.0
- v10.15.0
pr-url: https://github.com/nodejs/node/commit/186035243fad247e3955f
commit: 186035243fad247e3955f
pr-url: https://github.com/nodejs-private/node-private/pull/143
description: Max header size in `http_parser` was set to 8KB.
-->

Expand Down
2 changes: 1 addition & 1 deletion doc/api/http.md
View file
Open in desktop
Expand Up @@ -1193,7 +1193,7 @@ per connection (in the case of HTTP Keep-Alive connections).
added: v0.1.94
changes:
- version: v10.0.0
pr-url: v10.0.0
pr-url: https://github.com/nodejs/node/pull/19981
description: Not listening to this event no longer causes the socket
to be destroyed if a client sends an Upgrade header.
-->
Expand Down
3 changes: 3 additions & 0 deletions doc/api/http2.md
View file
Open in desktop
Expand Up @@ -2066,6 +2066,7 @@ changes:
- v14.4.0
- v12.18.0
- v10.21.0
commit: 3948830ce6408be620b09a70bf66158623022af0
pr-url: https://github.com/nodejs-private/node-private/pull/204
description: Added `maxSettings` option with a default of 32.
- version:
Expand Down Expand Up @@ -2207,6 +2208,7 @@ changes:
- v14.4.0
- v12.18.0
- v10.21.0
commit: 3948830ce6408be620b09a70bf66158623022af0
pr-url: https://github.com/nodejs-private/node-private/pull/204
description: Added `maxSettings` option with a default of 32.
- version:
Expand Down Expand Up @@ -2335,6 +2337,7 @@ changes:
- v14.4.0
- v12.18.0
- v10.21.0
commit: 3948830ce6408be620b09a70bf66158623022af0
pr-url: https://github.com/nodejs-private/node-private/pull/204
description: Added `maxSettings` option with a default of 32.
- version: v13.0.0
Expand Down
4 changes: 2 additions & 2 deletions doc/api/util.md
View file
Open in desktop
Expand Up @@ -1180,7 +1180,7 @@ is not supported.
added: v8.3.0
changes:
- version: v11.0.0
pr-url: v11.0.0
pr-url: https://github.com/nodejs/node/pull/22281
description: The class is now available on the global object.
-->

Expand Down Expand Up @@ -1241,7 +1241,7 @@ mark.
added: v8.3.0
changes:
- version: v11.0.0
pr-url: v11.0.0
pr-url: https://github.com/nodejs/node/pull/22281
description: The class is now available on the global object.
-->

Expand Down