Skip to content

doc: prefer server over srv - #31224

Closed
andrewhughes101 wants to merge 2 commits into
nodejs:masterfrom
andrewhughes101:http-docs
Closed

doc: prefer server over srv#31224
andrewhughes101 wants to merge 2 commits into
nodejs:masterfrom
andrewhughes101:http-docs

Conversation

@andrewhughes101

@andrewhughes101andrewhughes101 commented Jan 6, 2020

Copy link
Copy Markdown
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

@sam-githubsam-github left a comment

Copy link
Copy Markdown
Contributor

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.

Comment threaddoc/api/http.md Outdated
Comment threaddoc/api/http.md Outdated

@sam-githubsam-githubJan 6, 2020

Copy link
Copy Markdown
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

@TrottTrott left a comment •
edited
Loading

Copy link
Copy Markdown
Member

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

@BridgeARBridgeAR left a comment

Copy link
Copy Markdown
Member

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

andrewhughes101 commented Jan 7, 2020

Copy link
Copy Markdown
ContributorAuthor

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

@andrewhughes101andrewhughes101 changed the title doc: standardise usage of server vs srvdoc: prefer server over srvJan 7, 2020
@BridgeARBridgeAR added the author ready PRs that have at least one approval, no pending requests for changes, and a CI started. label Jan 7, 2020
@BridgeARBridgeAR 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

nodejs-github-bot commented Jan 9, 2020

Copy link
Copy Markdown
Collaborator

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

@Trott

Trott commented Jan 9, 2020

Copy link
Copy Markdown
Member

Landed in f2a089a...b0f67f2

@TrottTrott 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 <ruben@bridgewater.de>
Reviewed-By: Sam Roberts <vieuxtech@gmail.com>
Reviewed-By: Richard Lau <riclau@uk.ibm.com>
Reviewed-By: Beth Griggs <Bethany.Griggs@uk.ibm.com>
Reviewed-By: Luigi Pinca <luigipinca@gmail.com>
Reviewed-By: Rich Trott <rtrott@gmail.com>
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 <ruben@bridgewater.de>
Reviewed-By: Sam Roberts <vieuxtech@gmail.com>
Reviewed-By: Richard Lau <riclau@uk.ibm.com>
Reviewed-By: Beth Griggs <Bethany.Griggs@uk.ibm.com>
Reviewed-By: Luigi Pinca <luigipinca@gmail.com>
Reviewed-By: Rich Trott <rtrott@gmail.com>
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 <ruben@bridgewater.de>
Reviewed-By: Sam Roberts <vieuxtech@gmail.com>
Reviewed-By: Richard Lau <riclau@uk.ibm.com>
Reviewed-By: Beth Griggs <Bethany.Griggs@uk.ibm.com>
Reviewed-By: Luigi Pinca <luigipinca@gmail.com>
Reviewed-By: Rich Trott <rtrott@gmail.com>
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 <ruben@bridgewater.de>
Reviewed-By: Sam Roberts <vieuxtech@gmail.com>
Reviewed-By: Richard Lau <riclau@uk.ibm.com>
Reviewed-By: Beth Griggs <Bethany.Griggs@uk.ibm.com>
Reviewed-By: Luigi Pinca <luigipinca@gmail.com>
Reviewed-By: Rich Trott <rtrott@gmail.com>
@codebyterecodebytere 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 <ruben@bridgewater.de>
Reviewed-By: Sam Roberts <vieuxtech@gmail.com>
Reviewed-By: Richard Lau <riclau@uk.ibm.com>
Reviewed-By: Beth Griggs <Bethany.Griggs@uk.ibm.com>
Reviewed-By: Luigi Pinca <luigipinca@gmail.com>
Reviewed-By: Rich Trott <rtrott@gmail.com>
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 <ruben@bridgewater.de>
Reviewed-By: Sam Roberts <vieuxtech@gmail.com>
Reviewed-By: Richard Lau <riclau@uk.ibm.com>
Reviewed-By: Beth Griggs <Bethany.Griggs@uk.ibm.com>
Reviewed-By: Luigi Pinca <luigipinca@gmail.com>
Reviewed-By: Rich Trott <rtrott@gmail.com>
@codebyterecodebytere mentioned this pull request Mar 17, 2020
Merged
Sign up for freeto join this conversation on GitHub. Already have an account? Sign in to comment

Reviewers

@TrottTrottTrott approved these changes
@lpincalpincalpinca approved these changes
@richardlaurichardlaurichardlau approved these changes
@BethGriggsBethGriggsBethGriggs approved these changes
@BridgeARBridgeARBridgeAR approved these changes
+1 more reviewer
@sam-githubsam-githubsam-github approved these changes
Reviewers whose approvals may not affect merge requirements

Assignees

No one assigned

Labels

author readyPRs that have at least one approval, no pending requests for changes, and a CI started.docIssues and PRs related to the documentations.httpIssues 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