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

changed comment on duplex stream options #24247

Closed
wants to merge 1 commit into from
Closed

changed comment on duplex stream options #24247

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
4 changes: 2 additions & 2 deletions lib/_stream_writable.js
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -57,8 +57,8 @@ function WritableState(options, stream, isDuplex) {
// Duplex streams are both readable and writable, but share
// the same options object.
// However, some cases require setting options to different
// values for the readable and the writable sides of the duplex stream.
// These options can be provided separately as readableXXX and writableXXX.
// values for the readable and the writable sides of the duplex stream,
// e.g. options.readableObjectMode vs. options.writableObjectMode, etc.
Copy link

Choose a reason for hiding this comment

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

I think the changes will be unnecessary. I have no problem reading the this comment.

Copy link
Contributor Author

Choose a reason for hiding this comment

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

Hi jc090218. Thanks for your feedback.

I was able to make some sense of the 'XXX' comment eventually, after looking at the next few lines. I think I would have understood it more quickly were it as proposed.

You seem like someone that knows a lot about programming, way more than me. I'm a novice. Do you think others learning to program like me would benefit from the proposed change?

Copy link

Choose a reason for hiding this comment

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

Hi, jeswcollins,

I think you have a good point and perspective on the learner side of view. I would say when I learn programming that is basically what are the comments be worded. Thus everyone have their own way of learning, I do not think anyone can judge on each other's way of learning things. On my perspective, English is are not my native language and I recommend by wording thing like 'XXX' make thing simple and straightforward.

Let us wait what the contributor/member thinks. :D

if (typeof isDuplex !== 'boolean')
isDuplex = stream instanceof Stream.Duplex;

Expand Down