Skip to content

doc updates from joyent/node - #2378

Closed
jasnell wants to merge 20 commits into
nodejs:masterfrom
jasnell:doc-updates
Closed

doc updates from joyent/node#2378
jasnell wants to merge 20 commits into
nodejs:masterfrom
jasnell:doc-updates

Conversation

@jasnell

@jasnelljasnell commented Aug 14, 2015

Copy link
Copy Markdown
Member

These are various documentation PRs picked from joyent/node.
/cc @nodejs/documentation @nodejs/tsc

@misterdjules

misterdjules commented Aug 14, 2015

Copy link
Copy Markdown

@jasnell Is there a plan to land these in v0.12 and/or v0.10.x when it applies?

@jasnell

jasnell commented Aug 14, 2015

Copy link
Copy Markdown
MemberAuthor

Yes. I'll cherry pick as appropriate. Specifically, I'm following the new process of landing in master and cherry picking outwards to the various branches. Once this lands in master, I'll cherry pick out to 3.x, then to v0.12, and, where appropriate, to v0.10

@brendanashworthbrendanashworth added the doc Issues and PRs related to the documentations. label Aug 14, 2015
@jasnell

jasnell commented Aug 14, 2015

Copy link
Copy Markdown
MemberAuthor

That said, there are few more commits that I'm going to append in here so it's not quite ready to land yet

@jasnell

jasnell commented Aug 14, 2015

Copy link
Copy Markdown
MemberAuthor

Ok, this one should be ready to go! Can I get a review... (note, there are more doc updates coming from the joyent/node PR's. I'm still going through them and may tack them on to the end here before it lands)

@bnoordhuis

bnoordhuis commented Aug 14, 2015

Copy link
Copy Markdown
Member

LGTM but can you be consistent in how you write the commit log bodies? Capitalization and punctuation is a little bit of everything now. The convention is to have the status line in lower case and capitalize and punctuate in the body.

@jasnell

jasnell commented Aug 14, 2015

Copy link
Copy Markdown
MemberAuthor

Yes I'll try to keep that more consistent moving forward

@jasnell

jasnell commented Aug 14, 2015

Copy link
Copy Markdown
MemberAuthor

Ok, that's all of the doc updates in this round. Down to only a handful of doc updates remaining in joyent/node

thefourtheye
thefourtheye reviewed Aug 15, 2015
View reviewed changes
Comment threaddoc/api/globals.markdown

@thefourtheyethefourtheyeAug 15, 2015

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

This change is incomplete. The corresponding [module section]: modules.html has to be removed as well, as it is obsolete now.

@jasnell

jasnell commented Aug 22, 2015

Copy link
Copy Markdown
MemberAuthor

@thefourtheye ... ok, addressed those two issues and rebased on master.

@jasnell

jasnell commented Aug 26, 2015

Copy link
Copy Markdown
MemberAuthor

@thefourtheye ... ping ;-)

@thefourtheye

thefourtheye commented Aug 26, 2015

Copy link
Copy Markdown
Contributor

Ah, sorry for the delay. I checked again now. LGTM 👍

@jasnell

jasnell commented Aug 26, 2015

Copy link
Copy Markdown
MemberAuthor

Ok, need to rebase again then will land.

@jasnell
doc: Clarify the module.parent is set once
66a0af2
Per: jorrit/node@54a7f79Fixes: nodejs/node-v0.x-archive#6149
Originally submitted by @jorrit
@jasnell
doc: correct grammar in cluster.markdown
fcbd2bc
per: nodejs/node-v0.x-archive#14352
originally submitted by @AlexKVal
@jasnell
doc: code style cleanups in repl.markdown
81e4274
per: nodejs/node-v0.x-archive#8778
originally submitted by @reggi
@jasnell
doc: small clarifications to modules.markdown
3803291
per: nodejs/node-v0.x-archive#8708
A modified version of the original PR submitted by @builtbylane.
@jasnell
doc: update path.extname documentation
3d5056f
per: nodejs/node-v0.x-archive#8509
originally submitted by @thauburger
Adding an additional example to path.extname documentation
to demonstrate the case where the first character of the last
path component is '.'. This case is interesting, as something
like path.extname('.txt') returns an empty string. In this
case, .txt can be used as a valid file name (while arguably
maintaining an extension). I agree with Node's behavior in this
case, but I think the added example provides additional clarity
for the developer.
@jasnell
doc: improve working in stream.markdown
a90e5fe
per: nodejs/node-v0.x-archive#8430
originally submitted by @mscdex
@jasnell
doc: clarification on the 'close' event
0173b90
per: nodejs/node-v0.x-archive#8209
originally submitted by @jeromew
@jasnell
doc: update description of fs.exists in fs.markdown
e37f1c8
per: nodejs/node-v0.x-archive#7944
originally submitted by @oconnore
Minor update to the description in `fs.exists()`
@jasnell
doc: fixed typo in net.markdown (missing comma)
55c41df
per: nodejs/node-v0.x-archive#7930
originally submitted by @pbrewczynski
@jasnell
doc: small typo in domain.markdown
87bdb0a
per: nodejs/node-v0.x-archive#7715
originally submitted by @tonylukasavage
@jasnell
doc: update parameter name in net.markdown
1db5495
per: nodejs/node-v0.x-archive#7112
originally submitted by @Peekmo
@jasnell
doc: fix minor types and grammar in fs docs
8e44a54
per: nodejs/node-v0.x-archive#7431
Originally submitted by @linclark
@jasnell
doc: port is optional for socket.bind()
bc9cfd6
per: nodejs/node-v0.x-archive#25356
originally submitted by @dcousens
@jasnell
doc: fixed worker.id type
60ae572
per: nodejs/node-v0.x-archive#25459
originally submitted by @sonnyp
@jasnell
doc: update tense in child_process.markdown
a1a09ac
per: nodejs/node-v0.x-archive#25826
originally submitted by: @ClimbsRocks
jasnell added a commit that referenced this pull request Aug 26, 2015
@jasnell@rvagg
doc: minor grammatical update in crypto.markdown
3bd08aa
Per: nodejs/node-v0.x-archive#8878
Originally submitted by @jacksonhoose
Reviewed By: Sakthipriyan Vairamani <thechargingvolcano@gmail.com>
PR-URL: #2378
jasnell added a commit that referenced this pull request Aug 26, 2015
@jasnell@rvagg
doc: minor additional corrections and improvements
2f62455
Per feedback from @thefourtheye: (a) improve word on the
description of the `close` event in stream.markdown and
(b) remove `[module section]: modules.html` from
globals.markdown
Reviewed By: Sakthipriyan Vairamani <thechargingvolcano@gmail.com>
PR-URL: #2378
@Fishrock123Fishrock123 mentioned this pull request Aug 29, 2015
Closed
@rvaggrvagg mentioned this pull request Sep 2, 2015
Merged
rvagg added a commit to rvagg/io.js that referenced this pull request Sep 2, 2015
@rvagg
2015-09-02 io.js v3.3.0 Release
1a6e52d
Notable changes:
* build: Add a --link-module option to configure that can be used to
bundle additional JavaScript modules into a built binary
(Bradley Meck) nodejs#2497
* docs: Merge outstanding doc updates from joyent/node
(James M Snell) nodejs#2378
* http_parser: Significant performance improvement by having
http.Server consume all initial data from its net.Socket and parsing
directly without having to enter JavaScript. Any 'data' listeners on
the net.Socket will result in the data being "unconsumed" into
JavaScript, thereby undoing any performance gains.
(Fedor Indutny) nodejs#2355
* libuv: Upgrade to 1.7.3 (from 1.6.1), see
https://github.com/libuv/libuv/blob/v1.x/ChangeLog for details
(Saúl Ibarra Corretgé) nodejs#2310
* V8: Upgrade to 4.4.63.30 (from 4.4.63.26) (Michaël Zasso) nodejs#2482
rvagg added a commit to rvagg/io.js that referenced this pull request Sep 2, 2015
@rvagg
doc: update changelog for io.js v3.3.0
c60b392
Notable changes:
* build: Add a --link-module option to configure that can be used to
bundle additional JavaScript modules into a built binary
(Bradley Meck) nodejs#2497
* docs: Merge outstanding doc updates from joyent/node
(James M Snell) nodejs#2378
* http_parser: Significant performance improvement by having
http.Server consume all initial data from its net.Socket and parsing
directly without having to enter JavaScript. Any 'data' listeners on
the net.Socket will result in the data being "unconsumed" into
JavaScript, thereby undoing any performance gains.
(Fedor Indutny) nodejs#2355
* libuv: Upgrade to 1.7.3 (from 1.6.1), see
https://github.com/libuv/libuv/blob/v1.x/ChangeLog for details
(Saúl Ibarra Corretgé) nodejs#2310
* V8: Upgrade to 4.4.63.30 (from 4.4.63.26) (Michaël Zasso) nodejs#2482
cherry-picked from v3.x @ 1a6e52d
rvagg added a commit that referenced this pull request Sep 2, 2015
@rvagg
doc: update changelog for io.js v3.3.0
a06e11d
Notable changes:
* build: Add a --link-module option to configure that can be used to
bundle additional JavaScript modules into a built binary
(Bradley Meck) #2497
* docs: Merge outstanding doc updates from joyent/node
(James M Snell) #2378
* http_parser: Significant performance improvement by having
http.Server consume all initial data from its net.Socket and parsing
directly without having to enter JavaScript. Any 'data' listeners on
the net.Socket will result in the data being "unconsumed" into
JavaScript, thereby undoing any performance gains.
(Fedor Indutny) #2355
* libuv: Upgrade to 1.7.3 (from 1.6.1), see
https://github.com/libuv/libuv/blob/v1.x/ChangeLog for details
(Saúl Ibarra Corretgé) #2310
* V8: Upgrade to 4.4.63.30 (from 4.4.63.26) (Michaël Zasso) #2482
cherry-picked from v3.x @ 1a6e52d
PR-URL: #2653
Reviewed-By: cjihrig - Colin Ihrig <cjihrig@gmail.com>
rvagg added a commit that referenced this pull request Sep 3, 2015
@rvagg@Fishrock123
doc: update changelog for io.js v3.3.0
8a9a3bf
Notable changes:
* build: Add a --link-module option to configure that can be used to
bundle additional JavaScript modules into a built binary
(Bradley Meck) #2497
* docs: Merge outstanding doc updates from joyent/node
(James M Snell) #2378
* http_parser: Significant performance improvement by having
http.Server consume all initial data from its net.Socket and parsing
directly without having to enter JavaScript. Any 'data' listeners on
the net.Socket will result in the data being "unconsumed" into
JavaScript, thereby undoing any performance gains.
(Fedor Indutny) #2355
* libuv: Upgrade to 1.7.3 (from 1.6.1), see
https://github.com/libuv/libuv/blob/v1.x/ChangeLog for details
(Saúl Ibarra Corretgé) #2310
* V8: Upgrade to 4.4.63.30 (from 4.4.63.26) (Michaël Zasso) #2482
cherry-picked from v3.x @ 1a6e52d
PR-URL: #2653
Reviewed-By: cjihrig - Colin Ihrig <cjihrig@gmail.com>
@alisccoaliscco mentioned this pull request Apr 26, 2023
Open
Sign up for freeto join this conversation on GitHub. Already have an account? Sign in to comment

Reviewers

No reviews

Assignees

No one assigned

Labels

docIssues and PRs related to the documentations.

Projects

None yet

Milestone

No milestone

Development

Successfully merging this pull request may close these issues.

5 participants

@jasnell@misterdjules@bnoordhuis@thefourtheye@brendanashworth