Skip to content

doc: fix http and http2 writeEarlyHints() parameter - #45000

Merged
nodejs-github-bot merged 1 commit into
nodejs:mainfrom
meyfa:doc/write-early-hints
Oct 17, 2022
Merged

doc: fix http and http2 writeEarlyHints() parameter#45000
nodejs-github-bot merged 1 commit into
nodejs:mainfrom
meyfa:doc/write-early-hints

Conversation

@meyfa

Copy link
Copy Markdown
Contributor

Both http and http2 response.writeEarlyHints() take an object, not an array, as their first parameter. For http, this was updated in the examples via #44820 except for the final example, which this patch fixes.
The doc for the http2 version was not touched in #44820 although I am pretty sure from skimming the code that it behaves identically to http, and so propose to change its doc as well. Finally, some bogus headline levels are fixed in http2 docs.

Both http and http2 `response.writeEarlyHints()` take an object,
not an array, as their first parameter. For http, this was updated in
the examples via #44820 except for the final example, which this
patch fixes.
The doc for the http2 version was not touched in #44820 although
I am pretty sure from skimming the code that it behaves identically
to http, and so propose to change its doc as well.
Finally, some bogus headline levels are fixed in http2 docs.
@nodejs-github-bot

Copy link
Copy Markdown
Collaborator

Review requested:

  • @nodejs/http
  • @nodejs/http2
  • @nodejs/net

@nodejs-github-botnodejs-github-bot added the doc Issues and PRs related to the documentations. label Oct 14, 2022

@anonriganonrig 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

@mcollinamcollina 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

@mcollinamcollina added the request-ci Add this label to start a Jenkins CI on a PR. label Oct 14, 2022
@github-actionsgithub-actionsBot removed the request-ci Add this label to start a Jenkins CI on a PR. label Oct 14, 2022
@nodejs-github-bot

Copy link
Copy Markdown
Collaborator

@anonriganonrig 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

@anonriganonrig added author ready PRs that have at least one approval, no pending requests for changes, and a CI started. dont-land-on-v16.x labels Oct 14, 2022
@nodejs-github-bot

Copy link
Copy Markdown
Collaborator

@RafaelGSSRafaelGSS 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.

@anonriganonrig added the commit-queue Add this label to land a pull request using GitHub Actions. label Oct 17, 2022
@nodejs-github-botnodejs-github-bot removed the commit-queue Add this label to land a pull request using GitHub Actions. label Oct 17, 2022
@nodejs-github-bot

Copy link
Copy Markdown
Collaborator
Commit Queue failed
- Loading data for nodejs/node/pull/45000
✔ Done loading data for nodejs/node/pull/45000
----------------------------------- PR info ------------------------------------
Title doc: fix http and http2 writeEarlyHints() parameter (#45000)
⚠ Could not retrieve the email or name of the PR author's from user's GitHub profile!
Branch meyfa:doc/write-early-hints -> nodejs:main
Labels doc, author ready, dont-land-on-v14.x, dont-land-on-v16.x
Commits 1
- doc: fix http and http2 writeEarlyHints() parameter
Committers 1
- Fabian Meyer <3982806+meyfa@users.noreply.github.com>
PR-URL: https://github.com/nodejs/node/pull/45000
Reviewed-By: Yagiz Nizipli Reviewed-By: Matteo Collina Reviewed-By: Luigi Pinca Reviewed-By: Rafael Gonzaga ------------------------------ Generated metadata ------------------------------
PR-URL: https://github.com/nodejs/node/pull/45000
Reviewed-By: Yagiz Nizipli Reviewed-By: Matteo Collina Reviewed-By: Luigi Pinca Reviewed-By: Rafael Gonzaga --------------------------------------------------------------------------------
ℹ This PR was created on Fri, 14 Oct 2022 09:48:28 GMT
✔ Approvals: 4
✔ - Yagiz Nizipli (@anonrig): https://github.com/nodejs/node/pull/45000#pullrequestreview-1142652385
✔ - Matteo Collina (@mcollina) (TSC): https://github.com/nodejs/node/pull/45000#pullrequestreview-1142407342
✔ - Luigi Pinca (@lpinca): https://github.com/nodejs/node/pull/45000#pullrequestreview-1142699979
✔ - Rafael Gonzaga (@RafaelGSS): https://github.com/nodejs/node/pull/45000#pullrequestreview-1142741968
✖ Last GitHub CI failed
ℹ Green GitHub CI is sufficient
--------------------------------------------------------------------------------
✔ Aborted `git node land` session in /home/runner/work/node/node/.ncu
https://github.com/nodejs/node/actions/runs/3263494835

@nodejs-github-botnodejs-github-bot added the commit-queue-failed An error occurred while landing this pull request using GitHub Actions. label Oct 17, 2022
@mcollinamcollina added the request-ci Add this label to start a Jenkins CI on a PR. label Oct 17, 2022
@github-actionsgithub-actionsBot removed the request-ci Add this label to start a Jenkins CI on a PR. label Oct 17, 2022
@nodejs-github-bot

Copy link
Copy Markdown
Collaborator

@anonriganonrig added the commit-queue Add this label to land a pull request using GitHub Actions. label Oct 17, 2022
@nodejs-github-botnodejs-github-bot removed the commit-queue Add this label to land a pull request using GitHub Actions. label Oct 17, 2022
@nodejs-github-bot
nodejs-github-bot merged commit 76c9f04 into nodejs:mainOct 17, 2022
@nodejs-github-bot

Copy link
Copy Markdown
Collaborator

Landed in 76c9f04

RafaelGSS pushed a commit that referenced this pull request Nov 1, 2022
Both http and http2 `response.writeEarlyHints()` take an object,
not an array, as their first parameter. For http, this was updated in
the examples via #44820 except for the final example, which this
patch fixes.
The doc for the http2 version was not touched in #44820 although
I am pretty sure from skimming the code that it behaves identically
to http, and so propose to change its doc as well.
Finally, some bogus headline levels are fixed in http2 docs.
PR-URL: #45000
Reviewed-By: Yagiz Nizipli <yagiz@nizipli.com>
Reviewed-By: Matteo Collina <matteo.collina@gmail.com>
Reviewed-By: Luigi Pinca <luigipinca@gmail.com>
Reviewed-By: Rafael Gonzaga <rafael.nunu@hotmail.com>
@RafaelGSSRafaelGSS mentioned this pull request Nov 1, 2022
RafaelGSS pushed a commit that referenced this pull request Nov 10, 2022
Both http and http2 `response.writeEarlyHints()` take an object,
not an array, as their first parameter. For http, this was updated in
the examples via #44820 except for the final example, which this
patch fixes.
The doc for the http2 version was not touched in #44820 although
I am pretty sure from skimming the code that it behaves identically
to http, and so propose to change its doc as well.
Finally, some bogus headline levels are fixed in http2 docs.
PR-URL: #45000
Reviewed-By: Yagiz Nizipli <yagiz@nizipli.com>
Reviewed-By: Matteo Collina <matteo.collina@gmail.com>
Reviewed-By: Luigi Pinca <luigipinca@gmail.com>
Reviewed-By: Rafael Gonzaga <rafael.nunu@hotmail.com>
danielleadams pushed a commit that referenced this pull request Dec 30, 2022
Both http and http2 `response.writeEarlyHints()` take an object,
not an array, as their first parameter. For http, this was updated in
the examples via #44820 except for the final example, which this
patch fixes.
The doc for the http2 version was not touched in #44820 although
I am pretty sure from skimming the code that it behaves identically
to http, and so propose to change its doc as well.
Finally, some bogus headline levels are fixed in http2 docs.
PR-URL: #45000
Reviewed-By: Yagiz Nizipli <yagiz@nizipli.com>
Reviewed-By: Matteo Collina <matteo.collina@gmail.com>
Reviewed-By: Luigi Pinca <luigipinca@gmail.com>
Reviewed-By: Rafael Gonzaga <rafael.nunu@hotmail.com>
danielleadams pushed a commit that referenced this pull request Jan 3, 2023
Both http and http2 `response.writeEarlyHints()` take an object,
not an array, as their first parameter. For http, this was updated in
the examples via #44820 except for the final example, which this
patch fixes.
The doc for the http2 version was not touched in #44820 although
I am pretty sure from skimming the code that it behaves identically
to http, and so propose to change its doc as well.
Finally, some bogus headline levels are fixed in http2 docs.
PR-URL: #45000
Reviewed-By: Yagiz Nizipli <yagiz@nizipli.com>
Reviewed-By: Matteo Collina <matteo.collina@gmail.com>
Reviewed-By: Luigi Pinca <luigipinca@gmail.com>
Reviewed-By: Rafael Gonzaga <rafael.nunu@hotmail.com>
Sign up for freeto join this conversation on GitHub. Already have an account? Sign in to comment

Labels

author readyPRs that have at least one approval, no pending requests for changes, and a CI started.commit-queue-failedAn error occurred while landing this pull request using GitHub Actions.docIssues and PRs related to the documentations.

Projects

None yet

Development

Successfully merging this pull request may close these issues.

6 participants

@meyfa@nodejs-github-bot@mcollina@lpinca@anonrig@RafaelGSS