Make links from wgpu-types to wgpu work in docs.rs. #8572
Merged
+125 −64
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.
As a bonus, the macro now allows defining such links while writing the item name only once instead of twice.
Connections
Fixes #8199 (mostly).
Description
../<other crate>is not sufficient to link to another crate on docs.rs. This PR adds a macro which generates links that will work on docs.rs whencfg(docsrs)is set. The macro only applies towgpu-types; it would be trickier to make it work for links inwgpu-coreandwgpu-hal, but those links were fewer and less significant, so I figured it wasn't immediately worth doing.I discovered a presumed bug in docs.rs, rust-lang/docs.rs#3036, and this PR contains a workaround for it which will link to older documentation than ideal. The alternative would be to embed the latest version number ofFixed!wgpuintowgpu-types, which seems worse.Testing
cargo docto test local docsRUSTDOCFLAGS='--cfg=docsrs' cargo doc, manually edited together the resulting URLs withhttps://docs.rs/, and verified they worked in docs.rs.Squash or Rebase?
One commit
Checklist
cargo fmt.taplo format.cargo clippy --tests. If applicable, add:--target wasm32-unknown-unknowncargo xtask testto run tests.CHANGELOG.mdentry.