-
Notifications
You must be signed in to change notification settings - Fork 29.9k
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: add missing copyFile change history #35056
Conversation
f4f3270
to
a6b561f
Compare
It's debatable that this is worth including, especially considering the semver-major label of the original PR was added "defensively" as the PR was designed to fix a bug. I don't think we typically document these sorts of changes to APIs (?) because users should have been passing legitimate values in the first place. |
a6b561f
to
155c467
Compare
@mscdex i don't feel terribly strongly about the name change i suppose, but i think it's helpful for users who may wonder why references to a parameter have changed. In the interest of ensuring that the barriers to effective documentation grokking remain low, i think there is value in minimizing potential sources of confusion. |
I don't mind erring on the side of over-communicating in the change-logging YAML stuff, especially since the material is hidden by default in the rendered HTML docs. |
Landed in 06212bd |
PR-URL: #35056 Reviewed-By: Rich Trott <[email protected]>
PR-URL: #35056 Reviewed-By: Rich Trott <[email protected]>
PR-URL: #35056 Reviewed-By: Rich Trott <[email protected]>
PR-URL: nodejs#35056 Reviewed-By: Rich Trott <[email protected]>
Discovered when working to upgrade Electron to Node.js v14.x - the changes in #27044 were
semver-major
and thus should likely be added into the change history for those methods.cc @BridgeAR
Checklist
make -j4 test
(UNIX), orvcbuild test
(Windows) passes