Repository navigation
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
Activity
iwko commentedon Jun 7, 2018
@joyeecheung May I take this one?
joyeecheung commentedon Jun 7, 2018
@iwko Sure, go ahead!
BeniCheni commentedon Jun 23, 2018
Since didn't see any open PR fo 15 days from last comment so I opened #21479 to try this "good first issue" labeled issue. Thanks for your time to review.
TimothyGu commentedon Jun 23, 2018
@BeniCheni, hmm, did you see #21243 (linked above by GitHub automatically)?
BeniCheni commentedon Jun 23, 2018
Sorry about missing #21243. Closed my own duplicated PR.
doc: improve documentation of fs sync methods
doc: improve documentation of fs sync methods
lirantal commentedon Oct 14, 2018
@joyeecheung seems like we can close this issue having @iwko's PR landed already, unless there are other areas we want to make the change in...?
What do you think about zlib? the section for all the methods do specify the connection between the sync and async version of them here: https://nodejs.org/api/zlib.html#zlib_convenience_methods
adarshsaraogi commentedon Oct 24, 2018
Can i work on this issue
iwko commentedon Oct 24, 2018
@adarshsaraogi this issue is alread resolved and merged
Trott commentedon Nov 11, 2018
(As always, if I'm closing in error, please comment or re-open. Thanks.)