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:add documentation for the object fields return with fs.fstat #48620

Open
wants to merge 1 commit into
base: main
Choose a base branch
from

Conversation

talvaknin744
Copy link

add documentation for the object fields return with fs.fstats

add documentation for the object fields return with fs.fstat
@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 Jul 1, 2023
Copy link
Contributor

@aduh95 aduh95 left a comment

Choose a reason for hiding this comment

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

Thanks for the pull request! I'm not sure this is an addition we would like to do in this section, if the user follows the link to fs.Stats, they can already find an example of what such object contains. The issue of duplicating the data here is that it makes it more probable that one section or the other will drift off eventually if ever to add or remove properties to fs.Stats objects.

@talvaknin744
Copy link
Author

Thank you for your contribution. This pull request addresses bug #48574, as requested by @bnoordhuis. I appreciate your comment. Because of the changes, would it be best to close the pull request or mark it resolved?

@lpinca
Copy link
Member

lpinca commented Jul 12, 2023

I would just add a link to https://linux.die.net/man/2/fstat as suggested in #48574 (comment).

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 this pull request may close these issues.

4 participants