Skip to content

Commit 30f7802

Browse files
kemitchellMylesBorins
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 db10e94 commit 30f7802

File tree

1 file changed

+6
-6
lines changed

1 file changed

+6
-6
lines changed

doc/api/fs.md

Lines changed: 6 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -1036,25 +1036,25 @@ deprecated: v0.4.7
10361036

10371037
Synchronous lchown(2). Returns `undefined`.
10381038

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

1044-
* `srcpath` {String | Buffer}
1045-
* `dstpath` {String | Buffer}
1044+
* `existingPath` {String | Buffer}
1045+
* `newPath` {String | Buffer}
10461046
* `callback` {Function}
10471047

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

1051-
## fs.linkSync(srcpath, dstpath)
1051+
## fs.linkSync(existingPath, newPath)
10521052
<!-- YAML
10531053
added: v0.1.31
10541054
-->
10551055

1056-
* `srcpath` {String | Buffer}
1057-
* `dstpath` {String | Buffer}
1056+
* `existingPath` {String | Buffer}
1057+
* `newPath` {String | Buffer}
10581058

10591059
Synchronous link(2). Returns `undefined`.
10601060

0 commit comments

Comments
 (0)