-
Notifications
You must be signed in to change notification settings - Fork 29.9k
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: add new documentation lint rule #18726
Changes from all commits
File filter
Filter by extension
Conversations
Jump to
Diff view
Diff view
There are no files selected for viewing
Original file line number | Diff line number | Diff line change |
---|---|---|
|
@@ -159,9 +159,9 @@ repository, with a summary of the nominee's contributions, for example: | |
* Participation in other projects, teams, and working groups of the | ||
Node.js organization | ||
* Can be shown using the links | ||
`https://github.com/search?q=author%3A${GITHUB_ID}++org%3Anodejs&type=Issues` | ||
`https://github.com/search?q=author%3A${GITHUB_ID}++org%3Anodejs&type=Issues` | ||
and | ||
`https://github.com/search?q=commenter%3A${GITHUB_ID}++org%3Anodejs&type=Issues` | ||
`https://github.com/search?q=commenter%3A${GITHUB_ID}++org%3Anodejs&type=Issues` | ||
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. This is one of many changes that is honestly really troubling. There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. Yes, I do not like that one either. To me it seems like it is an issue with the linting rule though. |
||
* Other participation in the wider Node.js community | ||
|
||
Mention @nodejs/collaborators in the issue to notify other Collaborators about | ||
|
Original file line number | Diff line number | Diff line change |
---|---|---|
|
@@ -25,9 +25,9 @@ changes: | |
description: Added strict mode to the assert module. | ||
--> | ||
|
||
When using the `strict mode`, any `assert` function will use the equality used in | ||
the strict function mode. So [`assert.deepEqual()`][] will, for example, work the | ||
same as [`assert.deepStrictEqual()`][]. | ||
When using the `strict mode`, any `assert` function will use the equality used | ||
in the strict function mode. So [`assert.deepEqual()`][] will, for example, | ||
work the same as [`assert.deepStrictEqual()`][]. | ||
|
||
On top of that, error messages which involve objects produce an error diff | ||
instead of displaying both objects. That is not the case for the legacy mode. | ||
|
@@ -209,8 +209,8 @@ changes: | |
- version: v9.0.0 | ||
pr-url: https://github.com/nodejs/node/pull/15036 | ||
description: NaN is now compared using the | ||
[SameValueZero](https://tc39.github.io/ecma262/#sec-samevaluezero) | ||
comparison. | ||
[SameValueZero](https://tc39.github.io/ecma262/#sec-samevaluezero) | ||
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. The fact that a change like this has to be made is frustrating and not intuitive. There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. The issue here is that another linting rule does not check comments and using |
||
comparison. | ||
- version: v8.5.0 | ||
pr-url: https://github.com/nodejs/node/pull/15001 | ||
description: Error names and messages are now properly compared | ||
|
@@ -621,8 +621,8 @@ changes: | |
- version: v9.0.0 | ||
pr-url: https://github.com/nodejs/node/pull/15036 | ||
description: NaN is now compared using the | ||
[SameValueZero](https://tc39.github.io/ecma262/#sec-samevaluezero) | ||
comparison. | ||
[SameValueZero](https://tc39.github.io/ecma262/#sec-samevaluezero) | ||
comparison. | ||
- version: v9.0.0 | ||
pr-url: https://github.com/nodejs/node/pull/15001 | ||
description: Error names and messages are now properly compared | ||
|
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -1,6 +1,7 @@ | ||
# Buffer | ||
|
||
<!--introduced_in=v0.10.0--> | ||
<!--lint disable maximum-line-length--> | ||
|
||
> Stability: 2 - Stable | ||
|
||
|
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -1,6 +1,7 @@ | ||
# Child Process | ||
|
||
<!--introduced_in=v0.10.0--> | ||
<!--lint disable maximum-line-length--> | ||
|
||
> Stability: 2 - Stable | ||
|
||
|
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Hm, these two changes look somewhat weird but I can imagine that the new rule will otherwise complain about it even though it should not?