Allow intra doc link resolution failures, because they actually succeed when they need to but rust doesnt know#748
Merged
bors[bot] merged 1 commit intogfx-rs:masterfrom Jun 24, 2020
Conversation
…ed when they need to but rust doesnt know
kvark
approved these changes
Jun 24, 2020
Member
kvark
left a comment
There was a problem hiding this comment.
cargo doc will claim all the links cannot be resolved
// despite the fact that it works fine when it needs to
Is this a cargo bug then? Would be good to link to it from somewhere
Contributor
Author
|
well when running cargo doc for wgpu-types, wgpu is not built so there is no way for the links to succeed here. Might be worth disabling the warnings for this case alone. However I guess I should still make a cargo issue for the warnings to not appear when running cargo doc for wgpu. |
Member
|
bors r+ |
Contributor
This file contains hidden or 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
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
2 participants
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
cargo doc will create a lot of warnings due to the intra doc links pointing to wgpu.
The links work fine, but the warnings are no good because they show up when any any crate dependent on wgpu runs cargo doc.
Testing
Ran cargo doc from wgpu-types:
Ran cargo doc from wgpu: