Add cross-references to each wgpu type's documentation. #2653
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
jimblandy
requested changes
May 13, 2022
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
jimblandy
approved these changes
May 13, 2022
3 tasks
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Description
Added:
(The latter two are not present for
wgpu-typesitems 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:
Testing
I ran
cargo doc, saw no broken intra-doc link warnings, and inspected each type's page for correct appearance.