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.

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: fix two doc errors #2549

Merged
merged 1 commit into from
Sep 14, 2015
Merged

Conversation

Fishrock123
Copy link
Contributor

Found these while digging around.

process.stdout always blocks as of
20176a9

WritableState.buffer is getBuffer() as of
9158666

cc @orangemocha for the first one. I'm unaware of a case where it wouldn't block now.

@Fishrock123 Fishrock123 added the doc Issues and PRs related to the documentations. label Aug 25, 2015
@Fishrock123
Copy link
Contributor Author

I guess also cc @chrisdickinson for the latter.

@orangemocha
Copy link
Contributor

For the first one: I believe that's correct. LGTM

@evanlucas
Copy link
Contributor

LGTM

`process.stdout` always blocks as of
20176a9

`WritableState.buffer` is `getBuffer()` as of
9158666

PR-URL: nodejs#2549
Reviewed-By: Alexis Campailla <orangemocha@nodejs.org>
Reviewed-By: Evan Lucas <evanlucas@me.com>
@Fishrock123 Fishrock123 merged commit 892bf65 into nodejs:master Sep 14, 2015
@Fishrock123 Fishrock123 deleted the doc-corrections branch September 14, 2015 13:42
Fishrock123 added a commit that referenced this pull request Sep 15, 2015
`process.stdout` always blocks as of
20176a9

`WritableState.buffer` is `getBuffer()` as of
9158666

PR-URL: #2549
Reviewed-By: Alexis Campailla <orangemocha@nodejs.org>
Reviewed-By: Evan Lucas <evanlucas@me.com>
@Fishrock123 Fishrock123 mentioned this pull request Sep 15, 2015
7 tasks
Fishrock123 added a commit that referenced this pull request Sep 15, 2015
`process.stdout` always blocks as of
20176a9

`WritableState.buffer` is `getBuffer()` as of
9158666

PR-URL: #2549
Reviewed-By: Alexis Campailla <orangemocha@nodejs.org>
Reviewed-By: Evan Lucas <evanlucas@me.com>
@rvagg rvagg mentioned this pull request Sep 15, 2015
@rvagg rvagg mentioned this pull request Sep 22, 2015
@tschaub
Copy link

tschaub commented Sep 23, 2015

For the first one: I believe that's correct. LGTM

Having the docs say that process.stdout.write() is always blocking makes it sound like writes are synchronous. This doesn't look to be the case (see #2972). Would it make sense to update the docs to say that writes are always asynchronous? This seems more pertinent to users of process.stdout.write() than whether or not it blocks.

@Fishrock123
Copy link
Contributor Author

Would it make sense to update the docs to say that writes are always asynchronous? This seems more pertinent to users of process.stdout.write() than whether or not it blocks.

Ugh, this is way to confusing.

The call is asynchronous as in the actual write will (likely?) not occur during the function being called. It will later block the process to do the write, however. It is likely to be done in the I/O phase of that tick I believe.

That being said, I think there is some js-side data that is updated synchronously which is normally what you'd be checking from the same process.

cc @bnoordhuis who likely knows how the heck this actually works

@Fishrock123
Copy link
Contributor Author

Refs: #2972 (comment)

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
doc Issues and PRs related to the documentations.
Projects
None yet
Development

Successfully merging this pull request may close these issues.

4 participants