Skip to content
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.

Sign up for GitHub

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

Jump to bottom

Documentation is not clear enough regarding parameters in callback #31019

Closed
basickarl opened this issue Dec 18, 2019 · 3 comments
Closed

Documentation is not clear enough regarding parameters in callback #31019

basickarl opened this issue Dec 18, 2019 · 3 comments
Labels
doc Issues and PRs related to the documentations. net Issues and PRs related to the net subsystem.

Comments

@basickarl
Copy link

https://nodejs.org/docs/latest-v12.x/api/net.html#net_server_listen_options_callback

It states: callback <Function> Common parameter of server.listen() functions.

This does not give me any information if there are or if there are no any parameters when the function is called.
@juanarbol
Copy link
Member

Yeap, it's quite unclear.

You think this could be better with a code example? Or what do you suggest for this?

@Trott
Copy link
Member

Trott commented Dec 18, 2019

I'd be inclined to simply remove Common parameter of server.listen() functions. That text just muddies things. It's a callback. It's named callback. Its type is function. That by itself is pretty clear. Everything else can be in the text and examples.

@BridgeAR BridgeAR added doc Issues and PRs related to the documentations. net Issues and PRs related to the net subsystem. labels Dec 20, 2019
@dev-script
Copy link
Contributor

I would like to work on this issue.

@dev-script dev-script mentioned this issue Dec 23, 2019
Closed
3 tasks
BridgeAR pushed a commit that referenced this issue Jan 3, 2020
@dev-script @BridgeAR
doc: improve doc net:server.listen
9141366 
Remove line "Common parameter of server.listen() functions."
from net:server.listen callback functions because there is no
need of this line.

PR-URL: #31064
Fixes: #31019
Reviewed-By: Gireesh Punathil <gpunathi@in.ibm.com>
Reviewed-By: Colin Ihrig <cjihrig@gmail.com>
Reviewed-By: James M Snell <jasnell@gmail.com>
Reviewed-By: Ruben Bridgewater <ruben@bridgewater.de>
targos pushed a commit that referenced this issue Jan 14, 2020
@dev-script @targos
doc: improve doc net:server.listen
1f0a1d5 
Remove line "Common parameter of server.listen() functions."
from net:server.listen callback functions because there is no
need of this line.

PR-URL: #31064
Fixes: #31019
Reviewed-By: Gireesh Punathil <gpunathi@in.ibm.com>
Reviewed-By: Colin Ihrig <cjihrig@gmail.com>
Reviewed-By: James M Snell <jasnell@gmail.com>
Reviewed-By: Ruben Bridgewater <ruben@bridgewater.de>
BethGriggs pushed a commit that referenced this issue Feb 6, 2020
@dev-script @BethGriggs
doc: improve doc net:server.listen
f099494 
Remove line "Common parameter of server.listen() functions."
from net:server.listen callback functions because there is no
need of this line.

PR-URL: #31064
Fixes: #31019
Reviewed-By: Gireesh Punathil <gpunathi@in.ibm.com>
Reviewed-By: Colin Ihrig <cjihrig@gmail.com>
Reviewed-By: James M Snell <jasnell@gmail.com>
Reviewed-By: Ruben Bridgewater <ruben@bridgewater.de>
@snyk-bot snyk-bot mentioned this issue Jun 1, 2021
Open
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees
No one assigned
Labels
doc Issues and PRs related to the documentations. net Issues and PRs related to the net subsystem.
Projects
None yet
Milestone
No milestone
Development

Successfully merging a pull request may close this issue.

doc: improve doc net:server.listen
5 participants
@Trott @BridgeAR @basickarl @juanarbol @dev-script