Skip to content
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.

Sign up for GitHub

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

Jump to bottom

Add cross-references to each wgpu type's documentation. #2653

Merged
merged 2 commits into from
May 13, 2022
Merged

Add cross-references to each wgpu type's documentation. #2653

merged 2 commits into from
May 13, 2022

Commits on May 13, 2022

  1. Add cross-references to each wgpu type's documentation. 

    Added:
* WebGPU specification links.
* How to create an instance, if it is not all-public-fields.
* What function or enclosing type this type is used for.

(The latter two are not present for `wgpu-types` items due to the
dependency running the wrong direction for that — I saw existing
`../wgpu/` links, but those do not work on https://docs.rs/wgpu/.)

This commit specifically does not:
* substantially revise existing language, except where necessary to fit
  the new information, or when there was an obvious trivial improvement
  like adding a link to support "how to use this".
* add similar information to the documentation of types not directly
  corresponding to the WebGPU specification
    @kpreid
    kpreid committed May 13, 2022
    Configuration menu
    Copy the full SHA
    4ac4b0a View commit details
    Browse the repository at this point in the history

  2. Two more fixes to WebGPU spec links.

    @jimblandy
    jimblandy committed May 13, 2022
    Configuration menu
    Copy the full SHA
    86bc0fb View commit details
    Browse the repository at this point in the history