Revert "doc: clarify fs.symlink and fs.symlinkSync parameters"
authorBert Belder <bertbelder@gmail.com>
Tue, 23 Dec 2014 23:54:39 +0000 (00:54 +0100)
committerBert Belder <bertbelder@gmail.com>
Tue, 27 Jan 2015 18:18:23 +0000 (19:18 +0100)
The offending doc change clarified nothing, but put the arguments to
fs.symlink() and fs.symlinkSync() in the wrong order.

This reverts commit 8146f2e6077df08ff9db01d400c186dc90df2d61.

BUG: https://github.com/joyent/node/issues/8920
PR: https://github.com/joyent/node/pull/8936

doc/api/fs.markdown

index cdd62e4b704a8f0e260227828546d17977709296..822b13d7e7fca180b886f7a77e0e5b728115a553 100644 (file)
@@ -208,7 +208,7 @@ the completion callback.
 
 Synchronous link(2).
 
-## fs.symlink(srcpath, dstpath[, type], callback)
+## fs.symlink(destination, path[, type], callback)
 
 Asynchronous symlink(2). No arguments other than a possible exception are given
 to the completion callback.
@@ -217,7 +217,7 @@ is `'file'`) and is only available on Windows (ignored on other platforms).
 Note that Windows junction points require the destination path to be absolute.  When using
 `'junction'`, the `destination` argument will automatically be normalized to absolute path.
 
-## fs.symlinkSync(srcpath, dstpath[, type])
+## fs.symlinkSync(destination, path[, type])
 
 Synchronous symlink(2).