Permalink
Browse files

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 <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>
  • Loading branch information...
kemitchell authored and jasnell committed Oct 18, 2016
1 parent a83354a commit 0a307f90cd093912f77eda2214196835d38b1afc
Showing with 6 additions and 6 deletions.
  1. +6 −6 doc/api/fs.md
@@ -1034,25 +1034,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`.

0 comments on commit 0a307f9

Please sign in to comment.