-
Notifications
You must be signed in to change notification settings - Fork 30k
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: clarify text about internal module changes #22024
Conversation
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
"These are subject to change" is correct. The word subject is a verb here, not a noun. A more wordy way of saying it would be "These may be subjected to changes". However, probably for historical reasons, subject to change is the natural, idiomatic way to say it for native speakers.
(Aside: This is actually really interesting for me. I've never thought twice about the phrase subject to change and so I'm now realizing that I never really thought about exactly what each word means.)
lib/internal/readme.md
Outdated
@@ -2,5 +2,5 @@ | |||
|
|||
The modules in `lib/internal` are intended for internal use in Node.js core | |||
only, and are not accessible with `require()` from user modules. These are | |||
subject to change at **any** time. Reliance on these modules outside of core | |||
subjects to change at **any** time. Reliance on these modules outside of core |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
subject to change
is a phrase so this change is incorrect.
If you want to clarify it for people unfamiliar with the subject to change idiom, how about changing from this:
...to this:
Seems both clearer and more succinct to me. (I'm also 👍 on eliminating the emphasis on any if you want to do that too.) |
And I'd also be 👍 on making it clear what these refers to, so maybe this?:
|
I think this is one of those times that being a native speaker is a disadvantage when trying to explain things. You know whether a phrase is correct/incorrect but you're not exactly sure how to explain why. |
@Trott & @richardlau: |
The commit message is hard to understand. How about this?: doc: clarify text about internal module changes
Simplify phrasing for clarity and succinctness. |
no objection to new change; holding off on approving until commit message is 👍
Simplify phrasing for clarity and succinctness.
No problem. For a Node lover I hope I can make it better according to our suggestions and ideas. |
Looks like a thin boundary between clarity and expressiveness. Agreeing to all the comments above, and in addition acknowledging the doc improvement if it helps easy consumption for wider audience. |
Node.js Collaborators, please, add 👍 here if you approve fast-tracking. |
@richardlau Do you still object to this change? |
Landed in be322bd |
Simplify phrasing for clarity and succinctness. PR-URL: #22024 Reviewed-By: Gireesh Punathil <gpunathi@in.ibm.com> Reviewed-By: Rich Trott <rtrott@gmail.com> Reviewed-By: Vse Mozhet Byt <vsemozhetbyt@gmail.com> Reviewed-By: Ruben Bridgewater <ruben@bridgewater.de> Reviewed-By: Luigi Pinca <luigipinca@gmail.com>
Simplify phrasing for clarity and succinctness. PR-URL: #22024 Reviewed-By: Gireesh Punathil <gpunathi@in.ibm.com> Reviewed-By: Rich Trott <rtrott@gmail.com> Reviewed-By: Vse Mozhet Byt <vsemozhetbyt@gmail.com> Reviewed-By: Ruben Bridgewater <ruben@bridgewater.de> Reviewed-By: Luigi Pinca <luigipinca@gmail.com>
Thanks all! |
For a non-English native speaker it's hard to understand what it means.
So make it a common and more clearly speaking.
make -j4 test
(UNIX), orvcbuild test
(Windows) passes