Skip to content

Commit 0a307f9

Browse files
kemitchelljasnell
authored andcommitted
doc: clarify fs.link and fs.linkSync arguments
Clarifies documentation by replacing the argument names `srcpath` and `dstpath` with more descriptive `existingPath` and `newPath`, reflecting how POSIX describes `link()`. PR-URL: #9145 Reviewed-By: Sakthipriyan Vairamani <[email protected]> Reviewed-By: James M Snell <[email protected]> Reviewed-By: Luigi Pinca <[email protected]> Reviewed-By: Gibson Fahnestock <[email protected]>
1 parent a83354a commit 0a307f9

File tree

1 file changed

+6
-6
lines changed

1 file changed

+6
-6
lines changed

doc/api/fs.md

+6-6
Original file line numberDiff line numberDiff line change
@@ -1034,25 +1034,25 @@ deprecated: v0.4.7
10341034

10351035
Synchronous lchown(2). Returns `undefined`.
10361036

1037-
## fs.link(srcpath, dstpath, callback)
1037+
## fs.link(existingPath, newPath, callback)
10381038
<!-- YAML
10391039
added: v0.1.31
10401040
-->
10411041

1042-
* `srcpath` {String | Buffer}
1043-
* `dstpath` {String | Buffer}
1042+
* `existingPath` {String | Buffer}
1043+
* `newPath` {String | Buffer}
10441044
* `callback` {Function}
10451045

10461046
Asynchronous link(2). No arguments other than a possible exception are given to
10471047
the completion callback.
10481048

1049-
## fs.linkSync(srcpath, dstpath)
1049+
## fs.linkSync(existingPath, newPath)
10501050
<!-- YAML
10511051
added: v0.1.31
10521052
-->
10531053

1054-
* `srcpath` {String | Buffer}
1055-
* `dstpath` {String | Buffer}
1054+
* `existingPath` {String | Buffer}
1055+
* `newPath` {String | Buffer}
10561056

10571057
Synchronous link(2). Returns `undefined`.
10581058

0 commit comments

Comments
 (0)