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.

Sign up for GitHub

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

Jump to bottom

doc: update documentation in fs.StatsFs #54309

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

doc: update documentation in fs.StatsFs #54309

wants to merge 3 commits into from

Conversation

Codder-lab
Copy link

No description provided.

@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 Aug 10, 2024
@RedYetiDev
Copy link
Member

Thanks for the PR! In order for this to land, the commit message must start with the subsystem (fs), following by an active verb.

For example, a valid commit for this PR would start with fs: add ...

@RedYetiDev
Copy link
Member

Thanks for updating the commit message, but you need to rebase to overwrite the original message.

@Codder-lab Codder-lab changed the title #50749 Issue: Update documentation in fs.StatsFs #50749 fs: update documentation in fs.StatsFs Aug 10, 2024
@Codder-lab Codder-lab changed the title #50749 fs: update documentation in fs.StatsFs #50749 Issue: Update documentation in fs.StatsFs Aug 10, 2024
@Codder-lab Codder-lab force-pushed the suyashpotdar/update-statsfs-docs branch 3 times, most recently from 81179aa to e2651f7 Compare August 10, 2024 20:10
@Codder-lab
Copy link
Author

Thanks for updating the commit message, but you need to rebase to overwrite the original message.

Look at #54309

@Codder-lab Codder-lab force-pushed the suyashpotdar/update-statsfs-docs branch from aaccc27 to aa3c459 Compare August 11, 2024 11:56
@marco-ippolito
Copy link
Member

actually being a doc only it should be doc:

@Codder-lab Codder-lab force-pushed the suyashpotdar/update-statsfs-docs branch from aa3c459 to 3bd562c Compare August 11, 2024 13:13
@Codder-lab
Copy link
Author

Codder-lab commented Aug 11, 2024 •
edited
Loading

actually being a doc only it should be doc:

#54309 "Could you please verify if it is correct now?"

@marco-ippolito marco-ippolito changed the title #50749 Issue: Update documentation in fs.StatsFs doc: update documentation in fs.StatsFs Aug 11, 2024
RedYetiDev
RedYetiDev reviewed Aug 11, 2024
View reviewed changes
doc/api/fs.md Outdated
@@ -7509,6 +7509,19 @@ added:

Free blocks available to unprivileged users.

**Example:**
```javascript
Copy link
Member

Choose a reason for hiding this comment

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

Suggested change
```javascript
```mjs

Copy link
Author

Choose a reason for hiding this comment

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

Could you please verify all the changes?

doc/api/fs.md Outdated
@@ -7521,6 +7534,19 @@ added:

Free blocks in file system.

**Example:**
```javascript
Copy link
Member

Choose a reason for hiding this comment

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

Suggested change
```javascript
```mjs

doc/api/fs.md Outdated
@@ -7533,6 +7559,18 @@ added:

Total data blocks in file system.

**Example:**
```javascript
Copy link
Member

Choose a reason for hiding this comment

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

Suggested change
```javascript
```mjs

doc/api/fs.md Outdated
@@ -7569,6 +7607,17 @@ added:

Total file nodes in file system.

```javascript
Copy link
Member

Choose a reason for hiding this comment

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

Suggested change
```javascript
```mjs

RedYetiDev
RedYetiDev reviewed Aug 11, 2024
View reviewed changes
doc/api/fs.md Outdated
@@ -7509,6 +7509,19 @@ added:

Free blocks available to unprivileged users.

**Example:**
Copy link
Member

Choose a reason for hiding this comment

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

Suggested change
**Example:**

doc/api/fs.md Outdated
@@ -7521,6 +7534,19 @@ added:

Free blocks in file system.

**Example:**
Copy link
Member

Choose a reason for hiding this comment

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

Suggested change
**Example:**

doc/api/fs.md Outdated
@@ -7533,6 +7559,18 @@ added:

Total data blocks in file system.

**Example:**
Copy link
Member

Choose a reason for hiding this comment

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

Suggested change
**Example:**

Copy link
Author

Choose a reason for hiding this comment

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

Can you please verify the changes?

lpinca
lpinca reviewed Aug 13, 2024
View reviewed changes
doc/api/fs.md
```mjs
import { statfs } from "fs/promises";

async function getAvailableSpace(path) {
Copy link
Member

Choose a reason for hiding this comment

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

For the sake of simplicity, isn't it better to use top level await instead of an async function?

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@RedYetiDev RedYetiDev RedYetiDev left review comments

@lpinca lpinca lpinca left review comments

@jasnell jasnell jasnell approved these changes

Assignees
No one assigned
Labels
doc Issues and PRs related to the documentations. fs Issues and PRs related to the fs subsystem / file system.
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.
6 participants
@Codder-lab @RedYetiDev @marco-ippolito @jasnell @lpinca @nodejs-github-bot