-
Notifications
You must be signed in to change notification settings - Fork 30.6k
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
Conversation
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`][]. |
There was a problem hiding this comment.
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 :)
There was a problem hiding this 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.
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! |
Fixes: #25595
Checklist
make -j4 test
(UNIX), orvcbuild test
(Windows) passes