Skip to content

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 into
gfx-rs:masterfrom
rukai:allow_intra_doc_link_failure
Jun 24, 2020
Merged

Allow intra doc link resolution failures, because they actually succeed when they need to but rust doesnt know#748
bors[bot] merged 1 commit into
gfx-rs:masterfrom
rukai:allow_intra_doc_link_failure

Conversation

@rukai

@rukai rukai commented Jun 24, 2020

Copy link
Copy Markdown
Contributor

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:

  • before: warnings from this crate.
  • after: no warnings from this crate.

Ran cargo doc from wgpu:

  • before: warnings from this crate
  • after: no warnings from this crate

@kvark kvark left a comment

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

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

@rukai

rukai commented Jun 24, 2020

Copy link
Copy Markdown
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.

@kvark

kvark commented Jun 24, 2020

Copy link
Copy Markdown
Member

bors r+

@bors

bors Bot commented Jun 24, 2020

Copy link
Copy Markdown
Contributor

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants