Skip to content

Possible Typo in WebGPU documentation #39203

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.

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

Open
iampi31415 opened this issue Apr 20, 2025 · 2 comments
Open

Possible Typo in WebGPU documentation #39203

iampi31415 opened this issue Apr 20, 2025 · 2 comments
Labels
area: WebGPU Content:WebAPI Web API docs goal: clarity (Experimental label) Issues about unclear/confusing/inconcise content.

Comments

@iampi31415
Copy link

iampi31415 commented Apr 20, 2025

MDN URL

https://developer.mozilla.org/en-US/docs/Web/API/GPUCommandEncoder

What specific section or headline is this issue about?

https://developer.mozilla.org/en-US/docs/Web/API/GPUCommandEncoder#examples

What information was incorrect, unhelpful, or incomplete?

Quoting, but bold is mine:

The commands encoded by the GPUCommandEncoder are recoded into a GPUCommandBuffer using the GPUCommandEncoder.finish() method.

(If it really meant recoded it would be useful to know what is meant in this context.)


I'd also comment that the initial description:

The GPUCommandEncoder interface of the WebGPU API represents a command encoder, used to encode commands to be issued to the GPU.

Is in my view too vague. We know that .finish() puts them into a command buffer, but what does encoding mean here? Translating to Native API commands?

What did you expect to see?

Should be recorded or maybe stored, unless I misinterpret.

(If it really meant recoded it would be useful to know what is meant in this context.)

Do you have any supporting links, references, or citations?

No response

Do you have anything more you want to share?

MDN metadata

Page report details
@iampi31415 iampi31415 added the needs triage Triage needed by staff and/or partners. Automatically applied when an issue is opened. label Apr 20, 2025
@github-actions github-actions bot added Content:WebAPI Web API docs and removed Content:WebAPI Web API docs labels Apr 20, 2025
@caugner caugner added the goal: clarity (Experimental label) Issues about unclear/confusing/inconcise content. label Apr 22, 2025
@Josh-Cena
Copy link
Member

@chrisdavidmills could you advise?

@chrisdavidmills
Copy link
Contributor

Hi @iampi31415! Thanks for filing this. Some responses:

  1. Yes, "recoded" should be "recorded" ;-)
  2. Encoding is the terminology the spec uses, and I think you are on the right path when you say "Translating to Native API commands" — you use API commands to tell the browser what you want to do, and it translates those into native API commands to give to the platform GPU in the background.

@Josh-Cena Josh-Cena removed the needs triage Triage needed by staff and/or partners. Automatically applied when an issue is opened. label Apr 22, 2025
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
area: WebGPU Content:WebAPI Web API docs goal: clarity (Experimental label) Issues about unclear/confusing/inconcise content.
Projects
None yet
Development

No branches or pull requests

4 participants