1berry/nodejs
1
0
Fork 0
Code Issues Packages Projects Releases Wiki Activity

doc: clarify fs.link and fs.linkSync arguments

Browse Source 
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>
This commit is contained in:
Kyle E. Mitchell 2016-10-17 20:04:50 -07:00 committed by James M Snell
parent 3dbf900e85
commit 6f7cdf7ef0
1 changed files with 6 additions and 6 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

12
doc/api/fs.md
View File

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