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

doc: remove Returns: {undefined} #18951

Closed
wants to merge 2 commits into from
Closed

doc: remove Returns: {undefined} #18951

wants to merge 2 commits into from

Conversation

shqld
Copy link

@shqld shqld commented Feb 23, 2018

Removed * Returns: {undefined} in doc/ to prevent confusing users. Cf. #18775 (comment)

Checklist
  • make -j4 test (UNIX), or vcbuild test (Windows) passes
  • documentation is changed or added
  • commit message follows commit guidelines
Affected core subsystem(s)

doc

@nodejs-github-bot nodejs-github-bot added the doc Issues and PRs related to the documentations. label Feb 23, 2018
@vsemozhetbyt
Copy link
Contributor

vsemozhetbyt commented Feb 23, 2018 •
edited
Loading

CI-lite: https://ci.nodejs.org/job/node-test-pull-request-lite/193/ (green).

@vsemozhetbyt vsemozhetbyt added the fast-track PRs that do not need to wait for 48 hours to land. label Feb 23, 2018
@vsemozhetbyt
Copy link
Contributor

It seems http2session.settings(settings) is missed)

@BridgeAR
Copy link
Member

The change itself is LG but I am wondering if it would not be better to always add the return value instead. I know that is much more work but in that case there would not be any possibility for confusion at all.

What do others think?

@targos
Copy link
Member

targos commented Feb 23, 2018

I prefer it without the return value.

@BridgeAR BridgeAR added the author ready PRs that have at least one approval, no pending requests for changes, and a CI started. label Feb 23, 2018
@Fishrock123
Copy link
Contributor

How about "no return value"? I'm good either way, just wondering how clear or not we should make it.

Trott
Trott approved these changes Feb 23, 2018
View reviewed changes
Copy link
Member

@Trott Trott left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

LGTM as is.

@vsemozhetbyt
Copy link
Contributor

CI-lite 2: https://ci.nodejs.org/job/node-test-pull-request-lite/194/

@benjamingr
Copy link
Member

Landed in 646e67e , thanks for your contribution to Node.js :)

benjamingr pushed a commit that referenced this pull request Feb 26, 2018
doc: remove Returns: {undefined}
646e67e 
Removed * Returns: {undefined} in doc/ to prevent confusing users

PR-URL: #18951
Reviewed-By: Michaël Zasso <targos@protonmail.com>
Reviewed-By: Vse Mozhet Byt <vsemozhetbyt@gmail.com>
Reviewed-By: Luigi Pinca <luigipinca@gmail.com>
Reviewed-By: Ruben Bridgewater <ruben@bridgewater.de>
Reviewed-By: Tobias Nießen <tniessen@tnie.de>
Reviewed-By: Rich Trott <rtrott@gmail.com>
Reviewed-By: Tiancheng "Timothy" Gu <timothygu99@gmail.com>
Reviewed-By: Benjamin Gruenbaum <benjamingr@gmail.com>
@TimothyGu TimothyGu closed this Feb 26, 2018
addaleax pushed a commit to addaleax/node that referenced this pull request Feb 26, 2018
@addaleax
doc: remove Returns: {undefined}
5c727a0 
Removed * Returns: {undefined} in doc/ to prevent confusing users

PR-URL: nodejs#18951
Reviewed-By: Michaël Zasso <targos@protonmail.com>
Reviewed-By: Vse Mozhet Byt <vsemozhetbyt@gmail.com>
Reviewed-By: Luigi Pinca <luigipinca@gmail.com>
Reviewed-By: Ruben Bridgewater <ruben@bridgewater.de>
Reviewed-By: Tobias Nießen <tniessen@tnie.de>
Reviewed-By: Rich Trott <rtrott@gmail.com>
Reviewed-By: Tiancheng "Timothy" Gu <timothygu99@gmail.com>
Reviewed-By: Benjamin Gruenbaum <benjamingr@gmail.com>
@shqld
Copy link
Author

shqld commented Feb 26, 2018

Thanks Benjamin! XD

addaleax pushed a commit that referenced this pull request Feb 26, 2018
@addaleax
doc: remove Returns: {undefined}
287946d 
Removed * Returns: {undefined} in doc/ to prevent confusing users

PR-URL: #18951
Reviewed-By: Michaël Zasso <targos@protonmail.com>
Reviewed-By: Vse Mozhet Byt <vsemozhetbyt@gmail.com>
Reviewed-By: Luigi Pinca <luigipinca@gmail.com>
Reviewed-By: Ruben Bridgewater <ruben@bridgewater.de>
Reviewed-By: Tobias Nießen <tniessen@tnie.de>
Reviewed-By: Rich Trott <rtrott@gmail.com>
Reviewed-By: Tiancheng "Timothy" Gu <timothygu99@gmail.com>
Reviewed-By: Benjamin Gruenbaum <benjamingr@gmail.com>
@addaleax addaleax mentioned this pull request Feb 27, 2018
Closed
MayaLekova pushed a commit to MayaLekova/node that referenced this pull request May 8, 2018
@MayaLekova
doc: remove Returns: {undefined}
2e7b8a9 
Removed * Returns: {undefined} in doc/ to prevent confusing users

PR-URL: nodejs#18951
Reviewed-By: Michaël Zasso <targos@protonmail.com>
Reviewed-By: Vse Mozhet Byt <vsemozhetbyt@gmail.com>
Reviewed-By: Luigi Pinca <luigipinca@gmail.com>
Reviewed-By: Ruben Bridgewater <ruben@bridgewater.de>
Reviewed-By: Tobias Nießen <tniessen@tnie.de>
Reviewed-By: Rich Trott <rtrott@gmail.com>
Reviewed-By: Tiancheng "Timothy" Gu <timothygu99@gmail.com>
Reviewed-By: Benjamin Gruenbaum <benjamingr@gmail.com>
@jasnell
Copy link
Member

jasnell commented Aug 17, 2018

Does not land cleanly in 8.x. If this should be backported, a backport PR will be needed.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@Trott Trott Trott approved these changes

@benjamingr benjamingr benjamingr approved these changes

@lpinca lpinca lpinca approved these changes

@TimothyGu TimothyGu TimothyGu approved these changes

@targos targos targos approved these changes

@tniessen tniessen tniessen approved these changes

@BridgeAR BridgeAR BridgeAR approved these changes

@vsemozhetbyt vsemozhetbyt vsemozhetbyt approved these changes

Assignees
No one assigned
Labels
author ready PRs that have at least one approval, no pending requests for changes, and a CI started. doc Issues and PRs related to the documentations. fast-track PRs that do not need to wait for 48 hours to land.
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.