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.

Sign up for GitHub

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

Jump to bottom

doc: missing negation in streams doc #10710

Closed
jrieken opened this issue Jan 9, 2017 · 3 comments
Closed

doc: missing negation in streams doc #10710

jrieken opened this issue Jan 9, 2017 · 3 comments
Labels
doc Issues and PRs related to the documentations. stream Issues and PRs related to the stream subsystem.

Comments

@jrieken
Copy link
Contributor

jrieken commented Jan 9, 2017

from https://nodejs.org/dist/latest-v6.x/docs/api/stream.html#stream_errors_while_reading

The doc for Errors While Reading says:

Throwing an Error from within readable._read() can result in expected and inconsistent behavior depending on whether the stream is operating in flowing or paused mode. Using the 'error' event ensures consistent and predictable handling of errors.

and I believe it should be ...can result in UNexpected and inconsistent behavior...
@jrieken jrieken closed this as completed Jan 9, 2017
@jrieken
Copy link
Contributor Author

jrieken commented Jan 9, 2017

Seems to be fixed on master

@jrieken jrieken reopened this Jan 9, 2017
@evanlucas
Copy link
Contributor

hm, I still see it under Errors While Writing. Want to submit a pull request to fix?

@jrieken
Copy link
Contributor Author

jrieken commented Jan 9, 2017

Sure, will open PR. I was tricked by two Errors While Reading sections, one is correct...

jrieken added a commit to jrieken/node that referenced this issue Jan 9, 2017
@jrieken
Fix missing negation
14ad012 
This will fix nodejs#10710 by changing `..can result in expected` to `..can result in unexpected`
@jrieken jrieken mentioned this issue Jan 9, 2017
Closed
@mscdex mscdex added doc Issues and PRs related to the documentations. stream Issues and PRs related to the stream subsystem. labels Jan 9, 2017
italoacasas pushed a commit to italoacasas/node that referenced this issue Jan 18, 2017
@jrieken @italoacasas
doc: fix missing negation in stream.md
305c650 
Changing `..can result in expected` to `..can result in unexpected`

Fixes: nodejs#10710
PR-URL: nodejs#10712
Reviewed-By: Colin Ihrig <[email protected]>
Reviewed-By: James M Snell <[email protected]>
Reviewed-By: Luigi Pinca <[email protected]>
italoacasas pushed a commit to italoacasas/node that referenced this issue Jan 23, 2017
@jrieken @italoacasas
doc: fix missing negation in stream.md
a09cb27 
Changing `..can result in expected` to `..can result in unexpected`

Fixes: nodejs#10710
PR-URL: nodejs#10712
Reviewed-By: Colin Ihrig <[email protected]>
Reviewed-By: James M Snell <[email protected]>
Reviewed-By: Luigi Pinca <[email protected]>
italoacasas pushed a commit to italoacasas/node that referenced this issue Jan 24, 2017
@jrieken @italoacasas
doc: fix missing negation in stream.md
47d7719 
Changing `..can result in expected` to `..can result in unexpected`

Fixes: nodejs#10710
PR-URL: nodejs#10712
Reviewed-By: Colin Ihrig <[email protected]>
Reviewed-By: James M Snell <[email protected]>
Reviewed-By: Luigi Pinca <[email protected]>
italoacasas pushed a commit to italoacasas/node that referenced this issue Jan 27, 2017
@jrieken @italoacasas
doc: fix missing negation in stream.md
b73e98b 
Changing `..can result in expected` to `..can result in unexpected`

Fixes: nodejs#10710
PR-URL: nodejs#10712
Reviewed-By: Colin Ihrig <[email protected]>
Reviewed-By: James M Snell <[email protected]>
Reviewed-By: Luigi Pinca <[email protected]>
MylesBorins pushed a commit that referenced this issue Mar 7, 2017
@jrieken @MylesBorins
doc: fix missing negation in stream.md
0c5e02f 
Changing `..can result in expected` to `..can result in unexpected`

Fixes: #10710
PR-URL: #10712
Reviewed-By: Colin Ihrig <[email protected]>
Reviewed-By: James M Snell <[email protected]>
Reviewed-By: Luigi Pinca <[email protected]>
MylesBorins pushed a commit that referenced this issue Mar 9, 2017
@jrieken @MylesBorins
doc: fix missing negation in stream.md
b5fd61d 
Changing `..can result in expected` to `..can result in unexpected`

Fixes: #10710
PR-URL: #10712
Reviewed-By: Colin Ihrig <[email protected]>
Reviewed-By: James M Snell <[email protected]>
Reviewed-By: Luigi Pinca <[email protected]>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees
No one assigned
Labels
doc Issues and PRs related to the documentations. stream Issues and PRs related to the stream subsystem.
Projects
None yet
Milestone
No milestone
Development

Successfully merging a pull request may close this issue.

Fix missing negation jrieken/node
3 participants
@mscdex @evanlucas @jrieken