Skip to content

Commit

Permalink
doc: clarify fs.link and fs.linkSync arguments
Browse files Browse the repository at this point in the history
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 MylesBorins committed Dec 21, 2016
1 parent 40d3661 commit c14ac9f
Showing 1 changed file with 6 additions and 6 deletions.
12 changes: 6 additions & 6 deletions doc/api/fs.md
Original file line number Diff line number Diff line change
Expand Up @@ -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`.

Expand Down

0 comments on commit c14ac9f

Please sign in to comment.