From 977c54adb5e5b7f083f02a294ca2825fe8eb7f2f Mon Sep 17 00:00:00 2001 From: Phillip Alexander Date: Sat, 26 Oct 2013 13:13:56 -0700 Subject: [PATCH] doc: fs: clarify fs.symlink Windows specific args --- doc/api/fs.markdown | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/doc/api/fs.markdown b/doc/api/fs.markdown index f940e6364fe..f886b73dc7e 100644 --- a/doc/api/fs.markdown +++ b/doc/api/fs.markdown @@ -197,8 +197,8 @@ Synchronous link(2). Asynchronous symlink(2). No arguments other than a possible exception are given to the completion callback. -`type` argument can be either `'dir'`, `'file'`, or `'junction'` (default is `'file'`). It is only -used on Windows (ignored on other platforms). +The `type` argument can be set to `'dir'`, `'file'`, or `'junction'` (default +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.