-
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
State explicitly in docs that 'close' does not take any arguments #20018
Comments
cc @mcollina @nodejs/http2 does this look good? Feel free to suggest any structural changes, and I'd base the remaining issues on the finalized structure. |
This is fine. Want to open a PR? |
At nodejs/help#877 (comment), @mcollina had suggested opening a few "good first issues", and that was why I was interested in the structure of the issue (so that first time contributors find it convenient). That said, I'm willing to open a PR if that's what you're propose, but that wasn't the intent when I opened the issue. |
Added the "good first issue tag" |
Explicitly added in the docs that the close event does not expect any arguments when invoked. Fixes: nodejs#20018
Added wording to better state that it is in fact the listener that is not expecting any arguments Fixes: nodejs#20018
Explicitly added in the docs that the close event does not expect any arguments when invoked. Fixes: #20018 PR-URL: #20031 Reviewed-By: Vse Mozhet Byt <[email protected]> Reviewed-By: Trivikram Kamat <[email protected]> Reviewed-By: James M Snell <[email protected]>
Explicitly added in the docs that the close event does not expect any arguments when invoked. Fixes: nodejs#20018 PR-URL: nodejs#20031 Reviewed-By: Vse Mozhet Byt <[email protected]> Reviewed-By: Trivikram Kamat <[email protected]> Reviewed-By: James M Snell <[email protected]>
Explicitly added in the docs that the close event does not expect any arguments when invoked. Fixes: nodejs#20018 PR-URL: nodejs#20031 Reviewed-By: Vse Mozhet Byt <[email protected]> Reviewed-By: Trivikram Kamat <[email protected]> Reviewed-By: James M Snell <[email protected]>
Explicitly added in the docs that the close event does not expect any arguments when invoked. Fixes: nodejs#20018 PR-URL: nodejs#20031 Reviewed-By: Vse Mozhet Byt <[email protected]> Reviewed-By: Trivikram Kamat <[email protected]> Reviewed-By: James M Snell <[email protected]>
Explicitly added in the docs that the close event does not expect any arguments when invoked. Fixes: nodejs#20018 PR-URL: nodejs#20031 Reviewed-By: Vse Mozhet Byt <[email protected]> Reviewed-By: Trivikram Kamat <[email protected]> Reviewed-By: James M Snell <[email protected]>
Explicitly added in the docs that the close event does not expect any arguments when invoked. Fixes: nodejs#20018 PR-URL: nodejs#20031 Reviewed-By: Vse Mozhet Byt <[email protected]> Reviewed-By: Trivikram Kamat <[email protected]> Reviewed-By: James M Snell <[email protected]>
Explicitly added in the docs that the close event does not expect any arguments when invoked. Fixes: #20018 Backport-PR-URL: #22850 PR-URL: #20031 Reviewed-By: Vse Mozhet Byt <[email protected]> Reviewed-By: Trivikram Kamat <[email protected]> Reviewed-By: James M Snell <[email protected]>
In the
http2
module, theHttp2Session
class emits an event namedclose
, which is documented at https://github.com/nodejs/node/blob/master/doc/api/http2.md#event-close.As evident from the following function from
lib/internal/http2/core.js
, the event does not expect any arguments:However, the current docs do a poor job of communicating this, therefore creating confusion.
Thus, the fact that the
close
event does not expect arguments should be explicitly mentioned in the docs.The exact source can be found at:
node/doc/api/http2.md
Lines 126 to 131 in 6376d43
The text was updated successfully, but these errors were encountered: