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

doc: fixed a missing backtick which broke the styling #38260

Merged
merged 1 commit into from
Apr 17, 2021

Conversation

SiddharthShyniben
Copy link
Contributor

@SiddharthShyniben SiddharthShyniben commented Apr 16, 2021

Fixes #38257

@nodejs-github-bot nodejs-github-bot added doc Issues and PRs related to the documentations. fs Issues and PRs related to the fs subsystem / file system. labels Apr 16, 2021
@aduh95
Copy link
Contributor

aduh95 commented Apr 16, 2021

Fast-track?

@aduh95 aduh95 added the fast-track PRs that do not need to wait for 48 hours to land. label Apr 16, 2021
doc/api/fs.md Outdated
@@ -2481,7 +2481,7 @@ changes:
* `stats` {fs.Stats}

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}
The callback gets two arguments `(err, stats)` where `stats` is a {`fs.Stats`}
Copy link
Member

Choose a reason for hiding this comment

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

We seem to be stylizing "{...} object" without backticks? cc @nodejs/documentation

Copy link
Contributor

Choose a reason for hiding this comment

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

Yes, removing the backticks makes it a link, which would be preferable IMHO.

Suggested change
The callback gets two arguments `(err, stats)` where `stats` is a {`fs.Stats`}
The callback gets two arguments `(err, stats)` where `stats` is a {fs.Stats}

PR-URL: nodejs#38260
Reviewed-By: Benjamin Gruenbaum <benjamingr@gmail.com>
Reviewed-By: Nitzan Uziely <linkgoron@gmail.com>
Reviewed-By: Antoine du Hamel <duhamelantoine1995@gmail.com>
Reviewed-By: Colin Ihrig <cjihrig@gmail.com>
Reviewed-By: Darshan Sen <raisinten@gmail.com>
@aduh95
Copy link
Contributor

aduh95 commented Apr 17, 2021

Landed in 7d688d4. Thanks for the contribution :)

@aduh95 aduh95 merged commit 7d688d4 into nodejs:master Apr 17, 2021
@SiddharthShyniben
Copy link
Contributor Author

Welcome! It was nothing.

I can really feel the GitHub community after being able to contribute to Node.js. 😄

@SiddharthShyniben SiddharthShyniben deleted the patch-1 branch April 18, 2021 11:11
targos pushed a commit that referenced this pull request Sep 4, 2021
PR-URL: #38260
Reviewed-By: Benjamin Gruenbaum <benjamingr@gmail.com>
Reviewed-By: Nitzan Uziely <linkgoron@gmail.com>
Reviewed-By: Antoine du Hamel <duhamelantoine1995@gmail.com>
Reviewed-By: Colin Ihrig <cjihrig@gmail.com>
Reviewed-By: Darshan Sen <raisinten@gmail.com>
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. fast-track PRs that do not need to wait for 48 hours to land. fs Issues and PRs related to the fs subsystem / file system.
Projects
None yet
Development

Successfully merging this pull request may close these issues.

[Documentation]: Typo (likely misplaced "`")
9 participants