-
Notifications
You must be signed in to change notification settings - Fork 29.6k
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: remove 'you' from writing-tests.md #13319
Conversation
The commit and PR titles are a bit scary :) Maybe |
It's quite amusing that http://www2.ivcc.edu/rambo/tip_formal_writing_voice.htm uses "you" the whole way through. |
doc/guides/writing-tests.md
Outdated
@@ -232,8 +232,8 @@ For performance considerations, we only use a selected subset of ES.Next | |||
features in JavaScript code in the `lib` directory. However, when writing | |||
tests, for the ease of backporting, it is encouraged to use those ES.Next | |||
features that can be used directly without a flag in [all maintained branches] | |||
(https://github.com/nodejs/lts), you can check [node.green](http://node.green) | |||
for all available features in each release. | |||
(https://github.com/nodejs/lts), [node.green](http://node.green) can be used |
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.
While we're in here, fix the comma splice? (The comma here should be a period and node.green
is the start of a new sentence.)
For that matter, maybe eliminate the passive voice in that new sentence and add a normative trailing /
to the URL?
node.green lists available features in each release.
doc/guides/writing-tests.md
Outdated
@@ -274,8 +274,8 @@ These imported tests will be wrapped like this: | |||
/* eslint-enable */ | |||
``` | |||
|
|||
If you want to improve tests that have been imported this way, please send | |||
a PR to the upstream project first. When your proposed change is merged in | |||
In order to improve tests that have been imported this way, please send |
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.
Nit: Remove In order
:
To improve tests that have been imported this way, please send...
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.
Some nits, but LGTM
Noticed this while reading through writing-tests.md today. As per style guide avoid the use of you, your etc. Rational as per: http://www2.ivcc.edu/rambo/tip_formal_writing_voice.htm
Pushed commits to address comments. |
CI good, landed as 449dd71 |
Noticed this while reading through writing-tests.md today. As per style guide avoid the use of you, your etc. Rational as per: http://www2.ivcc.edu/rambo/tip_formal_writing_voice.htm PR-URL: #13319 Reviewed-By: Vse Mozhet Byt <vsemozhetbyt@gmail.com> Reviewed-By: Colin Ihrig <cjihrig@gmail.com> Reviewed-By: James M Snell <jasnell@gmail.com> Reviewed-By: Rich Trott <rtrott@gmail.com> Reviewed-By: Luigi Pinca <luigipinca@gmail.com>
Noticed this while reading through writing-tests.md today. As per style guide avoid the use of you, your etc. Rational as per: http://www2.ivcc.edu/rambo/tip_formal_writing_voice.htm PR-URL: #13319 Reviewed-By: Vse Mozhet Byt <vsemozhetbyt@gmail.com> Reviewed-By: Colin Ihrig <cjihrig@gmail.com> Reviewed-By: James M Snell <jasnell@gmail.com> Reviewed-By: Rich Trott <rtrott@gmail.com> Reviewed-By: Luigi Pinca <luigipinca@gmail.com>
Noticed this while reading through writing-tests.md today. As per style guide avoid the use of you, your etc. Rational as per: http://www2.ivcc.edu/rambo/tip_formal_writing_voice.htm PR-URL: #13319 Reviewed-By: Vse Mozhet Byt <vsemozhetbyt@gmail.com> Reviewed-By: Colin Ihrig <cjihrig@gmail.com> Reviewed-By: James M Snell <jasnell@gmail.com> Reviewed-By: Rich Trott <rtrott@gmail.com> Reviewed-By: Luigi Pinca <luigipinca@gmail.com>
Noticed this while reading through writing-tests.md today.
As per style guide avoid the use of you, your etc.
Rational as per: http://www2.ivcc.edu/rambo/tip_formal_writing_voice.htm
Checklist
make -j4 test
(UNIX), orvcbuild test
(Windows) passesAffected core subsystem(s)
doc