doc: change eventName type annotations #17666
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
addaleax
approved these changes
Dec 13, 2017
addaleax
added
doc
cjihrig
approved these changes
Dec 14, 2017
jasnell
approved these changes
Dec 14, 2017
evanlucas
approved these changes
Dec 14, 2017
|
Now that #17440 landed, this will need to be rebased and |
|
Sure, np! Can take care of that today. |
|
If I remember correctly @mscdex was not in favor of this due to numbers being "valid" or something like that. |
|
@lpinca I mean, that's sort of what I brought up in the original thread. Right now you can enter absolutely anything and it'll just be coerced to a string (if it's not a Symbol). |
|
Yes, I have nothing against this change, I'm actually +1 just wanted to get @mscdex attention as they might be interested/concerned. |
lpinca
approved these changes
Dec 14, 2017
apapirovski
approved these changes
Dec 14, 2017
Change type annotations for eventName in events API doc from {any} to {string|symbol} to be consistent with doc changes made in nodejs#17440.
Fixes: nodejs#17657
aprilwebster
force-pushed
the
doc-eventName-type
branch
from
e74cba2
to
431991c
Compare
BridgeAR
approved these changes
Dec 17, 2017
BridgeAR
added
the
author ready
|
Landed in b2432a7. Thanks for the contribution @aprilwebster and congrats on becoming a Contributor!! 🎉 |
apapirovski
pushed a commit
that referenced
this pull request
Dec 17, 2017
Change type annotations for eventName in events API doc
from {any} to {string|symbol}.
PR-URL: #17666
Fixes: #17657
Reviewed-By: Anna Henningsen <anna@addaleax.net>
Reviewed-By: Jon Moss <me@jonathanmoss.me>
Reviewed-By: Timothy Gu <timothygu99@gmail.com>
Reviewed-By: Colin Ihrig <cjihrig@gmail.com>
Reviewed-By: James M Snell <jasnell@gmail.com>
Reviewed-By: Evan Lucas <evanlucas@me.com>
Reviewed-By: Luigi Pinca <luigipinca@gmail.com>
Reviewed-By: Anatoli Papirovski <apapirovski@mac.com>
Reviewed-By: Ruben Bridgewater <ruben@bridgewater.de>
|
Thanks @apapirovski!! Hopefully I can make a few more contributions in the new year. Happy holidays! |
addaleax
removed
the
author ready
MylesBorins
pushed a commit
that referenced
this pull request
Jan 8, 2018
Change type annotations for eventName in events API doc
from {any} to {string|symbol}.
PR-URL: #17666
Fixes: #17657
Reviewed-By: Anna Henningsen <anna@addaleax.net>
Reviewed-By: Jon Moss <me@jonathanmoss.me>
Reviewed-By: Timothy Gu <timothygu99@gmail.com>
Reviewed-By: Colin Ihrig <cjihrig@gmail.com>
Reviewed-By: James M Snell <jasnell@gmail.com>
Reviewed-By: Evan Lucas <evanlucas@me.com>
Reviewed-By: Luigi Pinca <luigipinca@gmail.com>
Reviewed-By: Anatoli Papirovski <apapirovski@mac.com>
Reviewed-By: Ruben Bridgewater <ruben@bridgewater.de>
MylesBorins
pushed a commit
that referenced
this pull request
Jan 9, 2018
Change type annotations for eventName in events API doc
from {any} to {string|symbol}.
PR-URL: #17666
Fixes: #17657
Reviewed-By: Anna Henningsen <anna@addaleax.net>
Reviewed-By: Jon Moss <me@jonathanmoss.me>
Reviewed-By: Timothy Gu <timothygu99@gmail.com>
Reviewed-By: Colin Ihrig <cjihrig@gmail.com>
Reviewed-By: James M Snell <jasnell@gmail.com>
Reviewed-By: Evan Lucas <evanlucas@me.com>
Reviewed-By: Luigi Pinca <luigipinca@gmail.com>
Reviewed-By: Anatoli Papirovski <apapirovski@mac.com>
Reviewed-By: Ruben Bridgewater <ruben@bridgewater.de>
Merged
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.
Change type annotations for eventName in events API doc from {any} to
{string|symbol} to be consistent with doc changes made in #17440.
Fixes: #17657
Checklist
Affected core subsystem(s)
doc