Uh oh!
There was an error while loading. Please reload this page.
doc: unify and compact some fragments in fs.md - #20050
Conversation
vsemozhetbyt
commented
Apr 15, 2018
BridgeAR
commented
Apr 15, 2018
I just looked through the docs briefly and found the following: stats.isSymbolicLink() (and above seem to have two "returns"). And besides your findings that some functions note that they return I also noticed that some Than again, some functions have a bullet point as return type, e.g., |
This is my thoughts on these, but they are not strong opinions, so if there is some minimal consensus to change this I can do it in a new PR:
|
vsemozhetbyt
commented
Apr 16, 2018
Landed in 809eb27 |
PR-URL: #20050 Reviewed-By: Trivikram Kamat <trivikr.dev@gmail.com> Reviewed-By: Ruben Bridgewater <ruben@bridgewater.de>
@nodejs/documentation If anybody has opinions about notes in #20050 (comment), #20050 (comment), and #20050 (comment), please, let us know. |
PR-URL: #20050 Reviewed-By: Trivikram Kamat <trivikr.dev@gmail.com> Reviewed-By: Ruben Bridgewater <ruben@bridgewater.de>
PR-URL: nodejs#20050 Reviewed-By: Trivikram Kamat <trivikr.dev@gmail.com> Reviewed-By: Ruben Bridgewater <ruben@bridgewater.de>
Checklist
make -j4 test(UNIX), orvcbuild test(Windows) passesRefs: #19898 (comment)
@BridgeAR, @ryzokuken , please, let me know if I am missing some other deviations in format patterns.
There is a questionable case in this doc I've abstained to change: many
Syncfunction descriptions contain notesReturns `undefined`.that are not commonly formalized. If I recall correctly, there were attempts to add formal* Returns: `undefined`all-docs-wide, but they were not adopted. In this case, these notes inSyncfunction descriptions may stress the specificity of these functions, so I've not deleted them during cleaning some other possible tautology. If they should be deleted, let me know.