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

doc: add missing copyFile change history #35056

Closed
wants to merge 1 commit into from

Conversation

codebytere
Copy link
Member

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), or vcbuild test (Windows) passes
  • documentation is changed or added
  • commit message follows commit guidelines

@codebytere codebytere requested a review from BridgeAR September 4, 2020 18:08
@nodejs-github-bot nodejs-github-bot added doc Issues and PRs related to the documentations. fs Issues and PRs related to the fs subsystem / file system. labels Sep 4, 2020
doc/api/fs.md Outdated Show resolved Hide resolved
@mscdex
Copy link
Contributor

mscdex commented Sep 4, 2020

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.

@codebytere
Copy link
Member Author

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

@Trott
Copy link
Member

Trott commented Sep 6, 2020

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.

@codebytere codebytere added the author ready PRs that have at least one approval, no pending requests for changes, and a CI started. label Sep 14, 2020
@codebytere
Copy link
Member Author

Landed in 06212bd

@codebytere codebytere closed this Sep 14, 2020
@codebytere codebytere deleted the add-flags-history branch September 14, 2020 16:52
codebytere added a commit that referenced this pull request Sep 14, 2020
ruyadorno pushed a commit that referenced this pull request Sep 17, 2020
@ruyadorno ruyadorno mentioned this pull request Sep 21, 2020
4 tasks
addaleax pushed a commit that referenced this pull request Sep 22, 2020
@codebytere codebytere mentioned this pull request Sep 28, 2020
joesepi pushed a commit to joesepi/node that referenced this pull request Jan 8, 2021
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
author ready PRs that have at least one approval, no pending requests for changes, and a CI started. doc Issues and PRs related to the documentations. fs Issues and PRs related to the fs subsystem / file system.
Projects
None yet
Development

Successfully merging this pull request may close these issues.

4 participants