doc: Clarify fs.symlink() usage #29700
Conversation
nodejs-github-bot
added
doc
Granjow
force-pushed
the
feature/granjow/docs-symlink
branch
from
1142b54 to
50e6c0b
Compare
|
@nodejs/fs |
|
Welcome, @Granjow! And thanks for the pull request! |
Granjow
force-pushed
the
feature/granjow/docs-symlink
branch
from
50e6c0b to
5436854
Compare
doc/api/fs.md
Outdated
| ``` | ||
|
|
||
| It creates a symbolic link named "new-port" that points to "foo". | ||
| creates a symbolic link `mewtwo` in the `example` which points to `mew` in the |
There was a problem hiding this comment.
Or maybe the first word just needs an initial capital letter?
There was a problem hiding this comment.
Oooohhh! I see what you're trying to do here. Don't use the code snippet as the subject to your sentence.
| creates a symbolic link `mewtwo` in the `example` which points to `mew` in the | |
| The above example creates a symbolic link `mewtwo` in the `example` which points to `mew` in the |
(You'll need to re-wrap at 80 chars if you accept this suggestion.)
There was a problem hiding this comment.
Sounds better indeed, changed it, thanks for the suggestion!
Granjow
force-pushed
the
feature/granjow/docs-symlink
branch
from
5436854 to
111d5f8
Compare
Granjow
force-pushed
the
feature/granjow/docs-symlink
branch
from
111d5f8 to
7ca5ce4
Compare
|
Commit message fixed as well … :) |
|
@Trott CI is failing for an unrelated reason. Is it still possible to get this PR merged? |
Jenkins CI passed and that's the one that counts. Travis CI is advisory only. So yes, this can land. |
|
Landed in 2487f39 |
|
Thanks for the contribution! 🎉 |
PR-URL: nodejs#29700 Reviewed-By: Anna Henningsen <[email protected]> Reviewed-By: James M Snell <[email protected]>
|
Cool, thank you! =) |
PR-URL: #29700 Reviewed-By: Anna Henningsen <[email protected]> Reviewed-By: James M Snell <[email protected]>
Clarify the
fs.symlink()parameters and state that relative paths are not resolved by Node.js.Checklist