-
Notifications
You must be signed in to change notification settings - Fork 29.8k
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: unify and compact some fragments in fs.md #20050
Conversation
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.
LGTM, Will rebase mine if this gets landed first.
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:
|
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
Sync
function 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 inSync
function 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.