doc: remove confusing signature in fs.md #18310
Closed
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
nodejs-github-bot
added
doc
vsemozhetbyt
added
the
fast-track
joyeecheung
approved these changes
Jan 23, 2018
doc/api/fs.md
Outdated
| @@ -2762,8 +2762,6 @@ added: v0.1.31 | |||
|
|
|||
| * `filename` {string|Buffer} | |||
| * `listener` {Function|undefined} **Default:** `undefined` | |||
There was a problem hiding this comment.
Since listener is listed as optional in the signature, we may just remove the undefined here and mention it is optional.
Also to avoid the confusion, maybe something like
- `listener` {Function} Optional, a listener previously attached using `fs.watchFile()`
?
gireeshpunathil
approved these changes
Jan 23, 2018
richardlau
approved these changes
Jan 23, 2018
|
Landed in 9870b53 |
MayaLekova
pushed a commit
to MayaLekova/node
that referenced
this pull request
May 8, 2018
PR-URL: nodejs#18310 Fixes: nodejs#18305 Refs: nodejs#13424 Reviewed-By: Joyee Cheung <joyeec9h3@gmail.com> Reviewed-By: Gireesh Punathil <gpunathi@in.ibm.com> Reviewed-By: Richard Lau <riclau@uk.ibm.com>
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Checklist
make -j4 test(UNIX), orvcbuild test(Windows) passesAffected core subsystem(s)
doc, fs
Fixes: #18305
This signature has been added in #13424. It seems to be erroneous as it can make an inattentive reader (me at least) think that
listeneris not a previously defined listener forfs.watchFile(), but a new callback forfs.unwatchFile(). Sorry if I am wrong and doubly confusing.