WebGPU PR #4 — Interfaces for handling errors and queries by chrisdavidmills · Pull Request #25184 · mdn/content

chrisdavidmills · 2023-03-08T17:48:01Z

Important: DO NOT merge this PR until #25174 has been merged.

Description

This PR is part of a multi-PR series that aims to document the WebGPU API. The interfaces documented in this PR are:

GPUCompilationInfo (done)
GPUCompilationMessage (done)
GPUDeviceLostInfo (done)
GPUError (done)
GPUInternalError (done)
GPUOutOfMemoryError (done)
GPUPipelineError (done)
GPUQuerySet (done)
GPUUncapturedErrorEvent (done)
GPUValidationError (done)

Note that the main PR for this series is #24202 — that one must be merged first, before any others! after that, and each subsequent one, is merged, main should be merged into the next PR, and the documentation integrity must be checked (e.g. do all the links work) before merging.

You can see full details of the additions expected in the WebGPU docs in my research document.

Motivation

Additional details

Related issues and pull requests

github-actions · 2023-03-08T17:50:06Z

Preview URLs (31 pages)

Flaws (7)

Note! 27 documents with no flaws that don't need to be listed. 🎉

URL: /en-US/docs/Web/API/GPUPipelineError
Title: GPUPipelineError
Flaw count: 1

bad_bcd_queries:
- No BCD data for query: api.GPUPipelineError

URL: /en-US/docs/Web/API/GPUPipelineError/GPUPipelineError
Title: GPUPipelineError()
Flaw count: 1

bad_bcd_queries:
- No BCD data for query: api.GPUPipelineError.GPUPipelineError

URL: /en-US/docs/Web/API/GPUPipelineError/reason
Title: GPUPipelineError.reason
Flaw count: 1

bad_bcd_queries:
- No BCD data for query: api.GPUPipelineError.reason

URL: /en-US/docs/Web/API/GPUQuerySet
Title: GPUQuerySet
Flaw count: 4

macros:
- /en-US/docs/Web/API/GPUCommandEncoder/beginRenderPass does not exist
- /en-US/docs/Web/API/GPUCommandEncoder/beginRenderPass does not exist
- /en-US/docs/Web/API/GPUCommandEncoder/beginComputePass does not exist
- /en-US/docs/Web/API/GPUCommandEncoder/writeTimeStamp does not exist

External URLs (14)

URL: /en-US/docs/Web/API/GPUInternalError
Title: GPUInternalError

https://toji.dev/webgpu-best-practices/error-handling (1 time) (Note! This may be a new URL 👀)

URL: /en-US/docs/Web/API/GPUInternalError/GPUInternalError
Title: GPUInternalError()

https://toji.dev/webgpu-best-practices/error-handling (1 time) (Note! This may be a new URL 👀)

URL: /en-US/docs/Web/API/GPUPipelineError
Title: GPUPipelineError

https://toji.dev/webgpu-best-practices/error-handling (1 time) (Note! This may be a new URL 👀)

URL: /en-US/docs/Web/API/GPUPipelineError/GPUPipelineError
Title: GPUPipelineError()

https://toji.dev/webgpu-best-practices/error-handling (1 time) (Note! This may be a new URL 👀)

URL: /en-US/docs/Web/API/GPUUncapturedErrorEvent
Title: GPUUncapturedErrorEvent

https://toji.dev/webgpu-best-practices/error-handling (1 time) (Note! This may be a new URL 👀)

URL: /en-US/docs/Web/API/GPUUncapturedErrorEvent/GPUUncapturedErrorEvent
Title: GPUUncapturedErrorEvent()

https://toji.dev/webgpu-best-practices/error-handling (1 time) (Note! This may be a new URL 👀)

URL: /en-US/docs/Web/API/GPUUncapturedErrorEvent/error
Title: GPUUncapturedErrorEvent.error

https://toji.dev/webgpu-best-practices/error-handling (1 time) (Note! This may be a new URL 👀)

URL: /en-US/docs/Web/API/GPUError
Title: GPUError

https://toji.dev/webgpu-best-practices/error-handling (1 time) (Note! This may be a new URL 👀)

URL: /en-US/docs/Web/API/GPUError/message
Title: GPUError.message

https://toji.dev/webgpu-best-practices/error-handling (1 time) (Note! This may be a new URL 👀)

URL: /en-US/docs/Web/API/GPUCompilationMessage/lineNum
Title: GPUCompilationMessage.lineNum

https://gpuweb.github.io/gpuweb/wgsl/ (1 time) (Note! This may be a new URL 👀)

URL: /en-US/docs/Web/API/GPUValidationError
Title: GPUValidationError

https://toji.dev/webgpu-best-practices/error-handling (1 time) (Note! This may be a new URL 👀)

URL: /en-US/docs/Web/API/GPUValidationError/GPUValidationError
Title: GPUValidationError()

https://toji.dev/webgpu-best-practices/error-handling (1 time) (Note! This may be a new URL 👀)

URL: /en-US/docs/Web/API/GPUOutOfMemoryError
Title: GPUOutOfMemoryError

https://toji.dev/webgpu-best-practices/error-handling (1 time) (Note! This may be a new URL 👀)

URL: /en-US/docs/Web/API/GPUOutOfMemoryError/GPUOutOfMemoryError
Title: GPUOutOfMemoryError()

https://toji.dev/webgpu-best-practices/error-handling (1 time) (Note! This may be a new URL 👀)

(comment last updated: 2023-04-05 13:37:15)

toji

Easiest batch yet!

files/en-us/web/api/gpucompilationmessage/index.md

files/en-us/web/api/gpucompilationmessage/message/index.md

files/en-us/web/api/gpucompilationmessage/type/index.md

chrisdavidmills · 2023-03-13T16:34:52Z

@toji OK, reference pages for all of the classes in this set now written and ready for review.

toji

New additions look good! Two minor clarifications requested regarding queries.

files/en-us/web/api/gpuqueryset/index.md

toji

LGTM! 👍

…rEvent

Elchi3

Merging as discussed in Slack. GPUPipelineError misses compat data, Chris will make a PR to BCD.

chrisdavidmills requested a review from a team as a code owner March 8, 2023 17:48

chrisdavidmills requested review from wbamberg and removed request for a team March 8, 2023 17:48

github-actions bot added the Content:WebAPI Web API docs label Mar 8, 2023

chrisdavidmills mentioned this pull request Mar 8, 2023

WebGPU API docs #24202

Merged

chrisdavidmills marked this pull request as draft March 8, 2023 17:49

toji reviewed Mar 8, 2023

View reviewed changes

files/en-us/web/api/gpucompilationmessage/index.md Show resolved Hide resolved

files/en-us/web/api/gpucompilationmessage/message/index.md Outdated Show resolved Hide resolved

files/en-us/web/api/gpucompilationmessage/type/index.md Outdated Show resolved Hide resolved

mdn deleted a comment from giftcardvalidator Mar 14, 2023

toji reviewed Mar 14, 2023

View reviewed changes

files/en-us/web/api/gpuqueryset/index.md Outdated Show resolved Hide resolved

files/en-us/web/api/gpuqueryset/index.md Show resolved Hide resolved

toji reviewed Mar 20, 2023

View reviewed changes

chrisdavidmills marked this pull request as ready for review April 3, 2023 08:55

chrisdavidmills mentioned this pull request Apr 3, 2023

WebGPU PR #5 — Interfaces for handling command encoding and submission #25312

Merged

chrisdavidmills added 6 commits April 5, 2023 14:11

Add reference docs for GPUCompilationInfo and GPUCompilationMessage

c2b5e1c

Document GPUDeviceLostInfo, and make fixes for toji comments

4904c4e

Add ref pages for GPUError and GPU[Internal|OutOfMemory|Validation]Error

8c6ad97

Add ref docs for GPUPipelineError, GPUQuerySet, and GPUUncapturedErro…

df42e2d

…rEvent

fixes for toji comments

ee3f751

fix typos, improve language

7dd0ad9

chrisdavidmills force-pushed the webgpu-docs-4-errors-queries branch from 716871a to 7dd0ad9 Compare April 5, 2023 13:12

Fixing a couple of minor flaws

4a237f9

Elchi3 approved these changes Apr 5, 2023

View reviewed changes

Elchi3 merged commit 93a8dbc into mdn:main Apr 5, 2023

chrisdavidmills deleted the webgpu-docs-4-errors-queries branch April 5, 2023 13:41

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Comments

WebGPU PR #4 — Interfaces for handling errors and queries#25184

WebGPU PR #4 — Interfaces for handling errors and queries#25184
Elchi3 merged 7 commits intomdn:mainfrom
chrisdavidmills:webgpu-docs-4-errors-queries

chrisdavidmills commented Mar 8, 2023 •

edited

Loading

Uh oh!

github-actions bot commented Mar 8, 2023 •

edited

Loading

Uh oh!

toji left a comment

Uh oh!

Uh oh!

Uh oh!

Uh oh!

chrisdavidmills commented Mar 13, 2023

Uh oh!

toji left a comment

Uh oh!

Uh oh!

Uh oh!

toji left a comment

Uh oh!

Elchi3 left a comment

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

4 participants

Comments

Conversation

chrisdavidmills commented Mar 8, 2023 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Description

Motivation

Additional details

Related issues and pull requests

Uh oh!

github-actions bot commented Mar 8, 2023 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

toji left a comment

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Uh oh!

Uh oh!

chrisdavidmills commented Mar 13, 2023

Uh oh!

toji left a comment

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Uh oh!

toji left a comment

Choose a reason for hiding this comment

Uh oh!

Elchi3 left a comment

Choose a reason for hiding this comment

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

4 participants

chrisdavidmills commented Mar 8, 2023 •

edited

Loading

github-actions bot commented Mar 8, 2023 •

edited

Loading