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.

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

[Documentation]: Typo (likely misplaced "`") #38257

Closed
SiddharthShyniben opened this issue Apr 16, 2021 · 2 comments · Fixed by #38260
Closed

[Documentation]: Typo (likely misplaced "`") #38257

SiddharthShyniben opened this issue Apr 16, 2021 · 2 comments · Fixed by #38260
Labels
doc Issues and PRs related to the documentations. fs Issues and PRs related to the fs subsystem / file system.

Comments

@SiddharthShyniben
Copy link
Contributor

I found a small mistake in the documentation for fs.lstat. It looks like a backtick was misplaced somewhere.

How it is:

Retrieves the <fs.Stats> for the symbolic link referred to by the path. The callback gets two arguments (err, stats) where stats is a {fs.Stats} object. lstat()is identical tostat(), except that if path` is a symbolic link, then the link itself is stat-ed, not the file that it refers to.

Retrieves the [<fs.Stats>](https://nodejs.org/api/fs.html#fs_class_fs_stats) for the symbolic link referred to by the path. The
callback gets two arguments `(err, stats)` where stats is a {`fs.Stats<!-- Missing backtick here -->} object. `lstat()`is
identical to`stat()`, except that if `path` is a symbolic link, then the link itself is stat-ed, not the file that it refers to.

How it should be:

Retrieves the <fs.Stats> for the symbolic link referred to by the path. The callback gets two arguments (err, stats) where stats is a {fs.Stats} object. lstat()is identical tostat(), except that if path is a symbolic link, then the link itself is stat-ed, not the file that it refers to.

Retrieves the [<fs.Stats>](https://nodejs.org/api/fs.html#fs_class_fs_stats) for the symbolic link referred to by the path. The
callback gets two arguments `(err, stats)` where stats is a {`fs.Stats`} object. `lstat()`is
identical to`stat()`, except that if `path` is a symbolic link, then the link itself is stat-ed, not the file that it refers to.

I can only assume that the documentation is in markdown, so I have given markdown code.

@Ayase-252 Ayase-252 added doc Issues and PRs related to the documentations. fs Issues and PRs related to the fs subsystem / file system. labels Apr 16, 2021
@Ayase-252
Copy link
Member

Thanks, would you send a PR to fix it? The relevant document is in doc/api/fs.md

@SiddharthShyniben
Copy link
Contributor Author

Will do (try...)

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
doc Issues and PRs related to the documentations. fs Issues and PRs related to the fs subsystem / file system.
Projects
None yet
Development

Successfully merging a pull request may close this issue.

2 participants