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

Improve documentation for fs.statfs with detailed descriptions and examples #57062

Open
wants to merge 2 commits into
base: main
Choose a base branch
from

Conversation

nileshsheth
Copy link

Summary

This PR enhances the documentation for fs.statfs by:

  • Adding a detailed breakdown of the returned fs.StatFs object.
  • Providing clear explanations of each property.
  • Including example usages for both normal and bigint: true options.
  • Improving readability for better developer understanding.

Changes Made

  • Updated doc/api/fs.md with improved descriptions.
  • Added code examples demonstrating usage.

Why?

  • The original documentation lacked details about the returned object.
  • No examples were provided, making it unclear for developers.

Related Issue

Closes nodejs/node#50749


Let me know if any additional improvements are needed! 🚀

@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 Feb 15, 2025
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.

Missing documentation in fs.StatFs
3 participants