Skip to content

Conversation

rukai
Copy link
Contributor

@rukai rukai commented Jun 24, 2020

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

Copy link
Member

@kvark kvark left a comment

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
Copy link
Contributor Author

rukai commented Jun 24, 2020

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
Copy link
Member

kvark commented Jun 24, 2020

bors r+

@bors
Copy link
Contributor

bors bot commented Jun 24, 2020

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