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

changed comment on duplex stream options #24247

Closed
wants to merge 1 commit into from

Conversation

@jeswcollins
Copy link
Contributor

commented Nov 8, 2018

'options.XXX' did not convey to me how to use camelCase for different readable and writable options on a duplex stream, so I gave an example instead.

Checklist
  • make -j4 test (UNIX), or vcbuild test (Windows) passes
  • tests and/or benchmarks are included
  • documentation is changed or added
  • commit message follows commit guidelines
changed comment on duplex stream options
'options.XXX' did not convey to me how to use camelCase for different readable and writable options on a duplex stream, so I gave an example instead.
@jcs090218
Copy link

left a comment

Short review on the PR base on personal preferences.

// 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.

This comment has been minimized.

Copy link
@jcs090218

jcs090218 Nov 9, 2018

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

This comment has been minimized.

Copy link
@jeswcollins

jeswcollins Nov 9, 2018

Author Contributor

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?

This comment has been minimized.

Copy link
@jcs090218

jcs090218 Nov 10, 2018

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

@lpinca
lpinca approved these changes Nov 13, 2018
@Trott

This comment has been minimized.

@Trott Trott added the author ready label Nov 15, 2018

Trott added a commit to Trott/io.js that referenced this pull request Nov 15, 2018
stream: change comment on duplex stream options
'options.XXX' did not convey to me how to use camelCase for different
readable and writable options on a duplex stream. Give an example
instead.

PR-URL: nodejs#24247
Reviewed-By: Anna Henningsen <anna@addaleax.net>
Reviewed-By: James M Snell <jasnell@gmail.com>
Reviewed-By: Luigi Pinca <luigipinca@gmail.com>
@Trott

This comment has been minimized.

Copy link
Member

commented Nov 15, 2018

Landed in d4653d5

@Trott Trott closed this Nov 15, 2018

@jeswcollins jeswcollins deleted the jeswcollins:patch-1 branch Nov 16, 2018

targos added a commit that referenced this pull request Nov 18, 2018
stream: change comment on duplex stream options
'options.XXX' did not convey to me how to use camelCase for different
readable and writable options on a duplex stream. Give an example
instead.

PR-URL: #24247
Reviewed-By: Anna Henningsen <anna@addaleax.net>
Reviewed-By: James M Snell <jasnell@gmail.com>
Reviewed-By: Luigi Pinca <luigipinca@gmail.com>
rvagg added a commit that referenced this pull request Nov 28, 2018
stream: change comment on duplex stream options
'options.XXX' did not convey to me how to use camelCase for different
readable and writable options on a duplex stream. Give an example
instead.

PR-URL: #24247
Reviewed-By: Anna Henningsen <anna@addaleax.net>
Reviewed-By: James M Snell <jasnell@gmail.com>
Reviewed-By: Luigi Pinca <luigipinca@gmail.com>
@BridgeAR BridgeAR referenced this pull request Dec 5, 2018
4 of 4 tasks complete
codebytere added a commit that referenced this pull request Jan 12, 2019
stream: change comment on duplex stream options
'options.XXX' did not convey to me how to use camelCase for different
readable and writable options on a duplex stream. Give an example
instead.

PR-URL: #24247
Reviewed-By: Anna Henningsen <anna@addaleax.net>
Reviewed-By: James M Snell <jasnell@gmail.com>
Reviewed-By: Luigi Pinca <luigipinca@gmail.com>
@codebytere codebytere referenced this pull request Jan 15, 2019
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
7 participants
You can’t perform that action at this time.