-
Notifications
You must be signed in to change notification settings - Fork 30.3k
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
doc: fix code example in fs.symlink
method
#40414
Conversation
@@ -3661,7 +3661,7 @@ Relative targets are relative to the link’s parent directory. | |||
```mjs | |||
import { symlink } from 'fs'; | |||
|
|||
symlink('./mew', './example/mewtwo', callback); | |||
symlink('./mew', './mewtwo', callback); |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
The text and bash output below here need to also be updated if we're changing the path.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Thank youuuu!
Do you mean this?
$ tree example/
example/
├── mew
└── mewtwo -> ./mew
I ran the new code example and got this:
➜ tree .
.
├── mew
└── mewtwo -> ./mew
0 directories, 2 files
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Whoops, you're right, I've changed the description, the bash thing is fine based on the tree
command output.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
The bash section does need to be changed. tree
shows you the directory tree of the directory you pass to it. Since './example/' is no longer involved in this symlink()
example, it doesn't make sense to show the tree of an unrelated directory. tree .
would be more relevant since it shows the symlink that was just created.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Yeap, fixed in 550b460
25dc26f
to
b79f2c1
Compare
Fixes: nodejs#40413 PR-URL: nodejs#40414 Reviewed-By: Antoine du Hamel <[email protected]>
550b460
to
ced518c
Compare
Landed in ced518c. |
Fixes: #40413 PR-URL: #40414 Reviewed-By: Antoine du Hamel <[email protected]>
Fixes: nodejs#40413 PR-URL: nodejs#40414 Reviewed-By: Antoine du Hamel <[email protected]>
Fixes: #40413 PR-URL: #40414 Reviewed-By: Antoine du Hamel <[email protected]>
Fixes: #40413