Skip to content

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

Merged
aduh95 merged 1 commit into
nodejs:masterfrom
juanarbol:juan/fix-fs-code-example
Oct 22, 2021
Merged

doc: fix code example in fs.symlink method#40414
aduh95 merged 1 commit into
nodejs:masterfrom
juanarbol:juan/fix-fs-code-example

Conversation

@juanarbol

Copy link
Copy Markdown
Member

Fixes: #40413

@nodejs-github-botnodejs-github-bot added doc Issues and PRs related to the documentations. fs Issues and PRs related to the fs subsystem / file system. labels Oct 11, 2021
Comment threaddoc/api/fs.md Outdated

Copy link
Copy Markdown
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
Copy Markdown
MemberAuthor

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
Copy Markdown
MemberAuthor

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.

@mscdexmscdexOct 12, 2021

Copy link
Copy Markdown
Contributor

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
Copy Markdown
MemberAuthor

Choose a reason for hiding this comment

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

Yeap, fixed in 550b460

@juanarbol
juanarbolforce-pushed the juan/fix-fs-code-example branch from 25dc26f to b79f2c1CompareOctober 12, 2021 14:11
Fixes: nodejs#40413
PR-URL: nodejs#40414
Reviewed-By: Antoine du Hamel <duhamelantoine1995@gmail.com>
@aduh95
aduh95force-pushed the juan/fix-fs-code-example branch from 550b460 to ced518cCompareOctober 22, 2021 22:45
@aduh95

Copy link
Copy Markdown
Contributor

Landed in ced518c.

@aduh95
aduh95 merged commit ced518c into nodejs:masterOct 22, 2021
targos pushed a commit that referenced this pull request Oct 23, 2021
Fixes: #40413
PR-URL: #40414
Reviewed-By: Antoine du Hamel <duhamelantoine1995@gmail.com>
@targostargos mentioned this pull request Nov 8, 2021
BethGriggs pushed a commit that referenced this pull request Nov 24, 2021
Fixes: #40413
PR-URL: #40414
Reviewed-By: Antoine du Hamel <duhamelantoine1995@gmail.com>
@BethGriggsBethGriggs mentioned this pull request Nov 26, 2021
1 task
@juanarbol
juanarbol deleted the juan/fix-fs-code-example branch October 24, 2022 13:48
Sign up for freeto join this conversation on GitHub. Already have an account? Sign in to comment

Labels

docIssues and PRs related to the documentations.fsIssues and PRs related to the fs subsystem / file system.

Projects

None yet

Development

Successfully merging this pull request may close these issues.

doc: symlink docs contain erroneous sample code

4 participants

@juanarbol@aduh95@mscdex@nodejs-github-bot