-
Notifications
You must be signed in to change notification settings - Fork 949
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
Document when types are not WebGPU types. #3235
Conversation
Codecov Report
@@ Coverage Diff @@
## master #3235 +/- ##
==========================================
- Coverage 64.64% 64.63% -0.01%
==========================================
Files 82 82
Lines 39501 39501
==========================================
- Hits 25534 25532 -2
- Misses 13967 13969 +2
Help us with your feedback. Take ten seconds to tell us how you rate us. Have a feature suggestion? Share it here. |
The only thing I worry about is that people might interpret this as them being native features, not just that they're unique to wgpu. |
Hmm. For that concern, what do you think of something like
The idea being to emphasize that this is a “Rust bindings” thing. |
That looks great |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
For above change.
I also changed the wording in BufferSlice to be more consistent with other documentation.
Done. For example,
|
Checklist
cargo clippy
.RUSTFLAGS=--cfg=web_sys_unstable_apis cargo clippy --target wasm32-unknown-unknown
if applicable.Add change to CHANGELOG.md. See simple instructions inside file.Skipping thisConnections
This is a probably-less-interesting side branch from #2653 where I added documentation linking to the WebGPU specification to many types.
Description
This change documents types that don't correspond to the WebGPU specification, so readers can know they are unique to
wgpu
.I also changed the wording in
BufferSlice
to be more consistent with other documentation.Testing
Only documentation was changed. I manually examined the rustdoc output.