doc: explicitly mention that the explanation of an synchronous fs API live in the docs of the async API #21197
Description
- Version: master
- Subsystem: fs, doc
In a lot of cases, the documentation of a synchronous fs API only links to the aysnc version of that API in order to reduce duplicated texts.
For example, fs.readSync() only mentions
Synchronous version of fs.read(). Returns the number of bytesRead.
Which could be confusing to beginners since it does not explicitly mention that if they want to see a detailed explanation of the arguments, they should click the link of fs.read(). It would be more friendly if, for example, in the fs.readSync() docs we explicitly say:
Synchronous version of fs.read(). Returns the number of bytesRead.
For detailed information, see the documentation of fs.read().
And do the same for other fs.*Sync APIs if applicable.
Refs: #21193