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: prefer server over srv #31224

Closed
wants to merge 2 commits into from
Closed

doc: prefer server over srv #31224

wants to merge 2 commits into from

Conversation

andrewhughes101
Copy link
Contributor

Changed http tests and documentation to use server instead of a mixture of srv and server

Checklist
  • make -j4 test (UNIX), or vcbuild test (Windows) passes
  • tests and/or benchmarks are included
  • documentation is changed or added
  • commit message follows commit guidelines

sam-github
sam-github reviewed Jan 6, 2020
View reviewed changes
Copy link
Contributor

@sam-github sam-github left a comment

Choose a reason for hiding this comment

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

I've no strong opinions here, but changing srv without changing clt somewhat increases the inconsistency, IMO.

doc/api/http.md Outdated Show resolved Hide resolved
doc/api/http.md
@@ -525,11 +525,11 @@ A client server pair demonstrating how to listen for the `'upgrade'` event.
const http = require('http');

// Create an HTTP server
const srv = http.createServer((req, res) => {
const server = http.createServer((req, res) => {
Copy link
Contributor

Choose a reason for hiding this comment

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

Also, notice the obiquitous use use TLAs in the HTTP API.

Trott
Trott reviewed Jan 6, 2020
View reviewed changes
Copy link
Member

@Trott Trott left a comment •
edited
Loading

Choose a reason for hiding this comment

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

Optional nit: doc/STYLE_GUIDE.md codifies a preference for American spellings, so s/standardise/standardize/ in the commit messages maybe?

Or get rid of standardi[sz]e altogether and go with something like test: prefer server over srv and doc: prefer server over srv?

Without a lint rule, it seems likely that srv will creep back in at some point. But in general I prefer longer and more descriptive variable names to abbreviated ones, so I'm OK with this.

BridgeAR
BridgeAR approved these changes Jan 6, 2020
View reviewed changes
Copy link
Member

@BridgeAR BridgeAR left a comment

Choose a reason for hiding this comment

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

LGTM with the suggestion from @Trott. Changing client as well in the same PR also seems ideal.

@andrewhughes101
Copy link
Contributor Author

Thanks for the reviews, Ive changed clt to client as well and fixed up the commit messages.

@andrewhughes101 andrewhughes101 changed the title doc: standardise usage of server vs srv doc: prefer server over srv Jan 7, 2020
@BridgeAR BridgeAR added the author ready PRs that have at least one approval, no pending requests for changes, and a CI started. label Jan 7, 2020
@BridgeAR BridgeAR added doc Issues and PRs related to the documentations. http Issues or PRs related to the http subsystem. labels Jan 8, 2020
@nodejs-github-bot

This comment has been minimized.

Sign in to view
@nodejs-github-bot

This comment has been minimized.

Sign in to view
@nodejs-github-bot
Copy link
Collaborator

CI: https://ci.nodejs.org/job/node-test-pull-request/28311/

@Trott
Copy link
Member

Trott commented Jan 9, 2020

Landed in f2a089a...b0f67f2

@Trott Trott closed this Jan 9, 2020
Trott pushed a commit that referenced this pull request Jan 9, 2020
@andrewhughes101 @Trott
doc: prefer server vs srv and client vs clt
41dd175 
PR-URL: #31224
Reviewed-By: Ruben Bridgewater <[email protected]>
Reviewed-By: Sam Roberts <[email protected]>
Reviewed-By: Richard Lau <[email protected]>
Reviewed-By: Beth Griggs <[email protected]>
Reviewed-By: Luigi Pinca <[email protected]>
Reviewed-By: Rich Trott <[email protected]>
Trott pushed a commit that referenced this pull request Jan 9, 2020
@andrewhughes101 @Trott
test: prefer server over srv
b0f67f2 
PR-URL: #31224
Reviewed-By: Ruben Bridgewater <[email protected]>
Reviewed-By: Sam Roberts <[email protected]>
Reviewed-By: Richard Lau <[email protected]>
Reviewed-By: Beth Griggs <[email protected]>
Reviewed-By: Luigi Pinca <[email protected]>
Reviewed-By: Rich Trott <[email protected]>
MylesBorins pushed a commit that referenced this pull request Jan 16, 2020
@andrewhughes101 @MylesBorins
doc: prefer server vs srv and client vs clt
220ea0c 
PR-URL: #31224
Reviewed-By: Ruben Bridgewater <[email protected]>
Reviewed-By: Sam Roberts <[email protected]>
Reviewed-By: Richard Lau <[email protected]>
Reviewed-By: Beth Griggs <[email protected]>
Reviewed-By: Luigi Pinca <[email protected]>
Reviewed-By: Rich Trott <[email protected]>
MylesBorins pushed a commit that referenced this pull request Jan 16, 2020
@andrewhughes101 @MylesBorins
test: prefer server over srv
d76deca 
PR-URL: #31224
Reviewed-By: Ruben Bridgewater <[email protected]>
Reviewed-By: Sam Roberts <[email protected]>
Reviewed-By: Richard Lau <[email protected]>
Reviewed-By: Beth Griggs <[email protected]>
Reviewed-By: Luigi Pinca <[email protected]>
Reviewed-By: Rich Trott <[email protected]>
@codebytere codebytere mentioned this pull request Jan 16, 2020
Merged
codebytere pushed a commit that referenced this pull request Mar 14, 2020
@andrewhughes101 @codebytere
doc: prefer server vs srv and client vs clt
60e35d4 
PR-URL: #31224
Reviewed-By: Ruben Bridgewater <[email protected]>
Reviewed-By: Sam Roberts <[email protected]>
Reviewed-By: Richard Lau <[email protected]>
Reviewed-By: Beth Griggs <[email protected]>
Reviewed-By: Luigi Pinca <[email protected]>
Reviewed-By: Rich Trott <[email protected]>
codebytere pushed a commit that referenced this pull request Mar 14, 2020
@andrewhughes101 @codebytere
test: prefer server over srv
f3af68e 
PR-URL: #31224
Reviewed-By: Ruben Bridgewater <[email protected]>
Reviewed-By: Sam Roberts <[email protected]>
Reviewed-By: Richard Lau <[email protected]>
Reviewed-By: Beth Griggs <[email protected]>
Reviewed-By: Luigi Pinca <[email protected]>
Reviewed-By: Rich Trott <[email protected]>
@codebytere codebytere mentioned this pull request Mar 17, 2020
Merged
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@sam-github sam-github sam-github approved these changes

@Trott Trott Trott approved these changes

@lpinca lpinca lpinca approved these changes

@richardlau richardlau richardlau approved these changes

@BethGriggs BethGriggs BethGriggs approved these changes

@BridgeAR BridgeAR BridgeAR 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. http Issues or PRs related to the http subsystem.
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.
8 participants
@andrewhughes101 @nodejs-github-bot @Trott @sam-github @lpinca @richardlau @BethGriggs @BridgeAR