doc: replace uses of you and other style nits#12673
Uh oh!
There was an error while loading. Please reload this page.
Conversation
doc/api/cluster.md Outdated
There was a problem hiding this comment.
heh... yes, is should be either
jasnellforce-pushed the i-banish-you-from-the-docs branch from d801879 to 3213cfdComparedoc/api/globals.md Outdated
doc/api/modules.md Outdated
There was a problem hiding this comment.
Two spaces in succession.
gibfahn left a comment
gibfahn left a comment There was a problem hiding this comment.
Some nits (most of them from the existing docs, but while you're there)
doc/api/cluster.md Outdated
doc/api/cluster.md Outdated
doc/api/cluster.md Outdated
There was a problem hiding this comment.
allows distinguishs -> is used to distinguish
allows suggests that's just one of the things it can do right?
doc/api/cluster.md Outdated
There was a problem hiding this comment.
allows distinguishs -> is used to distinguish
as above...
doc/api/cluster.md Outdated
There was a problem hiding this comment.
server, a -> server a
I think that's easier to parse, happy to be disagreed with though.
doc/api/modules.md Outdated
doc/api/modules.md Outdated
There was a problem hiding this comment.
to allow cyclic module dependencies to what? The sentence as is suggests that they won't be allowed unless you plan carefully, but AIUI what will happen is that the application just won't work correctly.
Maybe:
to allow cyclic module dependencies to work correctly within an application.
doc/api/modules.md Outdated
There was a problem hiding this comment.
Maybe locally in -> node_modules folders in the local node_modules folder
doc/api/repl.md Outdated
There was a problem hiding this comment.
Maybe settings which -> settings, which
doc/api/net.md Outdated
There was a problem hiding this comment.
I don't think when...and works here. Can we be more specific about what is listening on '0.0.0.0'?
Sorry for not giving a concrete suggestion, I can't think of a good way to say this.
Replace uses of the pronouns `you` and `your` throughout the docs + other minor style nits
jasnellforce-pushed the i-banish-you-from-the-docs branch from 3213cfd to 83acb55Compare
jasnell commented Apr 28, 2017
@gibfahn ... updated! |
gibfahn left a comment
gibfahn left a comment There was a problem hiding this comment.
Thanks, LGTM. Especially impressed by how you fixed the bits where I basically said "this is bad, I have no constructive suggestions, please make better..."
Replace uses of the pronouns `you` and `your` throughout the docs + other minor style nits PR-URL: #12673 Reviewed-By: Vse Mozhet Byt <[email protected]> Reviewed-By: Benjamin Gruenbaum <[email protected]> Reviewed-By: Luigi Pinca <[email protected]> Reviewed-By: Colin Ihrig <[email protected]> Reviewed-By: Gibson Fahnestock <[email protected]>
jasnell commented Apr 28, 2017
Landed in 71f22c8 |
gibfahn commented Jun 18, 2017
Should this be backported to This looks reasonably easy to backport. |
7 participants
Replace uses of the pronouns
youandyourthroughout the docs + other minor style nitsChecklist
make -j4 test(UNIX), orvcbuild test(Windows) passesAffected core subsystem(s)
doc