changed comment on duplex stream options #24247
Conversation
'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.
nodejs-github-bot
added
the
stream
| // 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. |
There was a problem hiding this comment.
I think the changes will be unnecessary. I have no problem reading the this comment.
There was a problem hiding this comment.
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?
There was a problem hiding this comment.
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
Trott
added
the
author ready
'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 <[email protected]> Reviewed-By: James M Snell <[email protected]> Reviewed-By: Luigi Pinca <[email protected]>
|
Landed in d4653d5 |
'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 <[email protected]> Reviewed-By: James M Snell <[email protected]> Reviewed-By: Luigi Pinca <[email protected]>
'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 <[email protected]> Reviewed-By: James M Snell <[email protected]> Reviewed-By: Luigi Pinca <[email protected]>
'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 <[email protected]> Reviewed-By: James M Snell <[email protected]> Reviewed-By: Luigi Pinca <[email protected]>
'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), orvcbuild test(Windows) passes