Skip to content

doc: add missing copyFile change history - #35056

Closed
codebytere wants to merge 1 commit into
nodejs:masterfrom
codebytere:add-flags-history
Closed

doc: add missing copyFile change history#35056
codebytere wants to merge 1 commit into
nodejs:masterfrom
codebytere:add-flags-history

Conversation

@codebytere

Copy link
Copy Markdown
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

@nodejs-github-botnodejs-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
Comment threaddoc/api/fs.md Outdated
@mscdex

Copy link
Copy Markdown
Contributor

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
Copy Markdown
MemberAuthor

@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

Trott commented Sep 6, 2020

Copy link
Copy Markdown
Member

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.

@codebyterecodebytere 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
Copy Markdown
MemberAuthor

Landed in 06212bd

@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
PR-URL: #35056
Reviewed-By: Rich Trott <rtrott@gmail.com>
ruyadorno pushed a commit that referenced this pull request Sep 17, 2020
PR-URL: #35056
Reviewed-By: Rich Trott <rtrott@gmail.com>
@ruyadornoruyadorno mentioned this pull request Sep 21, 2020
4 tasks
addaleax pushed a commit that referenced this pull request Sep 22, 2020
PR-URL: #35056
Reviewed-By: Rich Trott <rtrott@gmail.com>
@codebyterecodebytere mentioned this pull request Sep 28, 2020
joesepi pushed a commit to joesepi/node that referenced this pull request Jan 8, 2021
PR-URL: nodejs#35056
Reviewed-By: Rich Trott <rtrott@gmail.com>
Sign up for freeto join this conversation on GitHub. Already have an account? Sign in to comment

Labels

author readyPRs that have at least one approval, no pending requests for changes, and a CI started.docIssues and PRs related to the documentations.fsIssues and PRs related to the fs subsystem / file system.

Projects

None yet

Development

Successfully merging this pull request may close these issues.

4 participants

@codebytere@mscdex@Trott@nodejs-github-bot