Skip to content
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.

Sign up for GitHub

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

Merged
merged 1 commit into from
Oct 22, 2021
Merged

doc: fix code example in fs.symlink method #40414

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
10 changes: 5 additions & 5 deletions doc/api/fs.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -3756,15 +3756,15 @@ Relative targets are relative to the link’s parent directory.
```mjs
import { symlink } from 'fs';

symlink('./mew', './example/mewtwo', callback);
symlink('./mew', './mewtwo', callback);
Copy link
Contributor

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.

Copy link
Member Author

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

Copy link
Member Author

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.

Copy link
Contributor

@mscdex mscdex Oct 12, 2021 •
edited
Loading

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.

Copy link
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Yeap, fixed in 550b460

```

The above example creates a symbolic link `mewtwo` in the `example` which points
to `mew` in the same directory:
The above example creates a symbolic link `mewtwo` which points to `mew` in the
same directory:

```bash
$ tree example/
example/
$ tree .
.
├── mew
└── mewtwo -> ./mew
```
Expand Down