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: updated directory entry information #32777

Closed
wants to merge 5 commits into from
Closed

doc: updated directory entry information #32777

wants to merge 5 commits into from

Conversation

el5846
Copy link
Contributor

@el5846 el5846 commented Apr 11, 2020

Fixes: #25595

Checklist
  • make -j4 test (UNIX), or vcbuild test (Windows) passes
  • documentation is changed or added
  • commit message follows commit guidelines

@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 11, 2020
doc/api/fs.md Outdated
A representation of a directory entry, as returned by reading from an
[`fs.Dir`][].
A representation of a directory entry, or a mapping of a filename to an
inode, as returned by reading from an [`fs.Dir`][].
Copy link
Member

Choose a reason for hiding this comment

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

Let's try to be a bit more specific here. Someone who doesn't know what a directory entry is, is also unlikely to know what an inode is – let alone the fact that inodes don't exist in certain file systems that we support, like NTFS.

Could you say something in the sense of "A representation of an entry of a file system directory. Examples for directory entries include files and subfolders in a folder that is being read from. Data included in [fs.Dirent][] objects include the filename in the directory it belongs to, and also possibly certain metadata about the type of the directory entry, but not the actual file content."

(I'm not a native English speaker, so you could probably make it sound a bit better :)

Copy link
Member

@Trott Trott left a comment

Choose a reason for hiding this comment

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

This seems to add a lot of backup files unintentionally.

@el5846 el5846 closed this Apr 12, 2020
@Trott
Copy link
Member

Trott commented Apr 12, 2020

Hi, @el5846! You don't need to close this. You can get rid of the backup files on your fork and push another commit to this branch! Although opening another pull request is fine too at this point.

Welcome, and thanks for the pull request! Do be aware that documentation pull requests can attract a lot of comments so patience with the process is appreciated!

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.

docs: Dirent definition doesn't tell me anything useful about Dirent
4 participants