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

[mmmeff]

Link: https://nodejs.org/api/fs.html#fs_class_fs_dirent

After clicking the link to this definition from the fs section on readDir, it seems circular and not at all helpful. After reading the definition, I still have no idea what a Dirent is.

[vsemozhetbyt]

There are some dirent.* methods and properties of class instances just below the class description, are they of any help?

[cjihrig]

Would the documentation be more useful if it contained the words "directory entry"?

[mmmeff]

@vsemozhetbyt I don't think the best way to explain a concept to someone reading documentation is to leave it up for interpretation based on the API.

@cjihrig Sure, and perhaps also a definition for what a "directory entry" is.

[manisaiprasad]

@mmmeff Directory Entry is basically the mapping of the filename to its inode, the inode contains all the data of the file except its name and the actual data in the file

if no one is working on this I can give a try

[HassanRazaMuhammadTufail]

Is this issue solved?

[addaleax]

@HassanRazaMuhammadTufail There is #32791, which will fix this issue – I’ll remove the good first issue label here for clarity :)