Skip to content

Follow-up fixes for Request/Response docs#6468

Merged
sideshowbarker merged 2 commits intomdn:mainfrom
Elchi3:request-response-fixes
Jul 3, 2021
Merged

Follow-up fixes for Request/Response docs#6468
sideshowbarker merged 2 commits intomdn:mainfrom
Elchi3:request-response-fixes

Conversation

@Elchi3
Copy link
Member

@Elchi3 Elchi3 commented Jun 30, 2021

The Request/Response docs are imprecise as noted in the review of #6455
This PR addresses the comments.

cc @foolip @sideshowbarker

@Elchi3 Elchi3 requested a review from a team as a code owner June 30, 2021 07:39
@Elchi3 Elchi3 requested review from wbamberg and removed request for a team June 30, 2021 07:39
@Elchi3 Elchi3 mentioned this pull request Jun 30, 2021
Merged
@github-actions
Copy link
Contributor

github-actions bot commented Jun 30, 2021 •
edited
Loading

Preview URLs

Flaws

URL: /en-US/docs/Web/API/Response
Title: Response
on GitHub
Flaw count: 5

  • macros:
    • /en-us/docs/web/api/body (url: /en-US/docs/Web/API/Body) does not exist
    • wrong xref macro used (consider changing which macro you use)
    • /en-US/docs/Web/API/Response/trailers does not exist
    • wrong xref macro used (consider changing which macro you use)
    • wrong xref macro used (consider changing which macro you use)

URL: /en-US/docs/Web/API/Response/json
Title: Response.json()
on GitHub
Flaw count: 2

  • macros:
    • /en-us/docs/web/api/body (url: /en-US/docs/Web/API/Body) does not exist
  • bad_bcd_queries:
    • No BCD data for query: api.Response.json

URL: /en-US/docs/Web/API/Response/text
Title: Response.text()
on GitHub
Flaw count: 2

  • macros:
    • /en-us/docs/web/api/body (url: /en-US/docs/Web/API/Body) does not exist
  • bad_bcd_queries:
    • No BCD data for query: api.Response.text

URL: /en-US/docs/Web/API/Request
Title: Request
on GitHub
Flaw count: 5

  • macros:
    • /en-us/docs/web/api/body (url: /en-US/docs/Web/API/Body) does not exist
    • wrong xref macro used (consider changing which macro you use)
    • wrong xref macro used (consider changing which macro you use)
  • bad_bcd_links:
    • no explanation!
    • no explanation!

URL: /en-US/docs/Web/API/Request/json
Title: Request.json()
on GitHub
Flaw count: 2

  • macros:
    • /en-us/docs/web/api/body (url: /en-US/docs/Web/API/Body) does not exist
  • bad_bcd_queries:
    • No BCD data for query: api.Request.json

URL: /en-US/docs/Web/API/Request/arrayBuffer
Title: Request.arrayBuffer()
on GitHub
Flaw count: 2

  • macros:
    • /en-us/docs/web/api/body (url: /en-US/docs/Web/API/Body) does not exist
  • bad_bcd_queries:
    • No BCD data for query: api.Request.arrayBuffer

URL: /en-US/docs/Web/API/Request/text
Title: Request.text()
on GitHub
Flaw count: 2

  • macros:
    • /en-us/docs/web/api/body (url: /en-US/docs/Web/API/Body) does not exist
  • bad_bcd_queries:
    • No BCD data for query: api.Request.text

URL: /en-US/docs/Web/API/Request/clone
Title: Request.clone()
on GitHub
Flaw count: 1

  • macros:
    • /en-us/docs/web/api/body (url: /en-US/docs/Web/API/Body) does not exist

URL: /en-US/docs/Web/API/Request/blob
Title: Request.blob()
on GitHub
Flaw count: 2

  • macros:
    • /en-us/docs/web/api/body (url: /en-US/docs/Web/API/Body) does not exist
  • bad_bcd_queries:
    • No BCD data for query: api.Request.blob

URL: /en-US/docs/Web/API/Request/formData
Title: Request.formData()
on GitHub
Flaw count: 2

  • macros:
    • /en-us/docs/web/api/body (url: /en-US/docs/Web/API/Body) does not exist
  • bad_bcd_queries:
    • No BCD data for query: api.Request.formData

External URLs

URL: /en-US/docs/Web/API/Response
Title: Response
on GitHub

No new external URLs

URL: /en-US/docs/Web/API/Response/json
Title: Response.json()
on GitHub

No new external URLs

URL: /en-US/docs/Web/API/Response/text
Title: Response.text()
on GitHub

No new external URLs

URL: /en-US/docs/Web/API/Request
Title: Request
on GitHub

No new external URLs

URL: /en-US/docs/Web/API/Request/json
Title: Request.json()
on GitHub

No new external URLs

URL: /en-US/docs/Web/API/Request/arrayBuffer
Title: Request.arrayBuffer()
on GitHub

No new external URLs

URL: /en-US/docs/Web/API/Request/text
Title: Request.text()
on GitHub

No new external URLs

URL: /en-US/docs/Web/API/Request/clone
Title: Request.clone()
on GitHub

No new external URLs

URL: /en-US/docs/Web/API/Request/blob
Title: Request.blob()
on GitHub

No new external URLs

URL: /en-US/docs/Web/API/Request/formData
Title: Request.formData()
on GitHub

No new external URLs

(this comment was updated 2021-07-01 07:20:38.842473)

foolip
foolip reviewed Jun 30, 2021
View reviewed changes
foolip
foolip approved these changes Jul 1, 2021
View reviewed changes
Copy link
Contributor

@foolip foolip left a comment

Choose a reason for hiding this comment

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

Thanks @Elchi3!

@sideshowbarker sideshowbarker merged commit 0dd45b6 into mdn:main Jul 3, 2021
@Elchi3 Elchi3 deleted the request-response-fixes branch July 5, 2021 07:13
@github-actions github-actions bot locked as resolved and limited conversation to collaborators Aug 1, 2022
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.

Reviewers

@sideshowbarker sideshowbarker sideshowbarker approved these changes

@wbamberg wbamberg Awaiting requested review from wbamberg

+1 more reviewer

@foolip foolip foolip approved these changes

Reviewers whose approvals may not affect merge requirements

Assignees

No one assigned

Labels

None yet

Projects

None yet

Milestone

No milestone

Development

Successfully merging this pull request may close these issues.

4 participants

@Elchi3 @sideshowbarker @wbamberg @foolip