From 30f7802b782fcc4460f25c171111844ead110931 Mon Sep 17 00:00:00 2001 From: "Kyle E. Mitchell" Date: Mon, 17 Oct 2016 20:04:50 -0700 Subject: [PATCH] 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 Reviewed-By: James M Snell Reviewed-By: Luigi Pinca Reviewed-By: Gibson Fahnestock --- doc/api/fs.md | 12 ++++++------ 1 file changed, 6 insertions(+), 6 deletions(-) diff --git a/doc/api/fs.md b/doc/api/fs.md index af7428b342..61ef618725 100644 --- a/doc/api/fs.md +++ b/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) -* `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) -* `srcpath` {String | Buffer} -* `dstpath` {String | Buffer} +* `existingPath` {String | Buffer} +* `newPath` {String | Buffer} Synchronous link(2). Returns `undefined`.