Browse Source

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: https://github.com/nodejs/node/pull/9145
Reviewed-By: Sakthipriyan Vairamani <thechargingvolcano@gmail.com>
Reviewed-By: James M Snell <jasnell@gmail.com>
Reviewed-By: Luigi Pinca <luigipinca@gmail.com>
Reviewed-By: Gibson Fahnestock <gibfahn@gmail.com>
v6.x
Kyle E. Mitchell 8 years ago
committed by Myles Borins
parent
commit
30f7802b78
  1. 12
      doc/api/fs.md

12
doc/api/fs.md

@ -1036,25 +1036,25 @@ deprecated: v0.4.7
Synchronous lchown(2). Returns `undefined`.
## fs.link(srcpath, dstpath, callback)
## fs.link(existingPath, newPath, callback)
<!-- YAML
added: v0.1.31
-->
* `srcpath` {String | Buffer}
* `dstpath` {String | Buffer}
* `existingPath` {String | Buffer}
* `newPath` {String | Buffer}
* `callback` {Function}
Asynchronous link(2). No arguments other than a possible exception are given to
the completion callback.
## fs.linkSync(srcpath, dstpath)
## fs.linkSync(existingPath, newPath)
<!-- YAML
added: v0.1.31
-->
* `srcpath` {String | Buffer}
* `dstpath` {String | Buffer}
* `existingPath` {String | Buffer}
* `newPath` {String | Buffer}
Synchronous link(2). Returns `undefined`.

Loading…
Cancel
Save