Join GitHub today
GitHub is home to over 28 million developers working together to host and review code, manage projects, and build software together.Sign up
doc: clarify fs.link and fs.linkSync arguments #9145
Affected core subsystem(s)
fs and doc
(Edited this answer 2016-10-19T20:46+0000 to show commits patch both fs and fs doc.)
Description of change
Clarifies documentation by replacing the
A few double-takes on my part inspired this small PR. As you're creating a new hard link, the "destination" seems like the new path, until it's actually done, when the "destination" of the new link seems like the prior-existing path.
The Linux manpage currently linked from doc names these arguments
I like these new names, it does seem more clear. If we change the docs I guess it would be inconsistent not to change the code to match.
I can't see how changing the names would affect any code using these functions, so it should be straightforward to change. Is there any possibility of parameter name change causing breakage?