Skip to content

Conversation

mockersf
Copy link
Member

  • makes CI fails on cargo doc warnings
  • adds this check in bors

doc warnings are listed here: https://doc.rust-lang.org/rustdoc/lints.html

Currently the warnings emitted are:

  • broken_intra_doc_links
  • private_intra_doc_links
  • invalid_codeblock_attributes

@mockersf mockersf added A-Build-System Related to build systems or continuous integration C-Docs An addition or correction to our documentation labels Apr 26, 2021
@cart
Copy link
Member

cart commented Apr 27, 2021

I dig it! This does make it slightly harder to remove continue-on-error because we now need to resolve all doc warnings too. But that seems like a reasonable thing to do :)

@cart
Copy link
Member

cart commented Apr 27, 2021

bors r+

bors bot pushed a commit that referenced this pull request Apr 27, 2021
* makes CI fails on cargo doc warnings
* adds this check in bors

doc warnings are listed here: https://doc.rust-lang.org/rustdoc/lints.html

Currently the warnings emitted are:
* broken_intra_doc_links
* private_intra_doc_links
* invalid_codeblock_attributes
@bors
Copy link
Contributor

bors bot commented Apr 27, 2021

@bors bors bot changed the title Fail CI on cargo doc warnings [Merged by Bors] - Fail CI on cargo doc warnings Apr 27, 2021
@bors bors bot closed this Apr 27, 2021
@mockersf
Copy link
Member Author

mockersf commented Apr 27, 2021

we now need to resolve all doc warnings too.

We currently don't have doc warnings 🎉 I fixed the few we had in #2007

And this new step is not continue-on-error so it will start failing today if a new issue is introduced!

@cart
Copy link
Member

cart commented Apr 27, 2021

Aaah thanks for the correction :)

ostwilkens pushed a commit to ostwilkens/bevy that referenced this pull request Jul 27, 2021
* makes CI fails on cargo doc warnings
* adds this check in bors

doc warnings are listed here: https://doc.rust-lang.org/rustdoc/lints.html

Currently the warnings emitted are:
* broken_intra_doc_links
* private_intra_doc_links
* invalid_codeblock_attributes
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
A-Build-System Related to build systems or continuous integration C-Docs An addition or correction to our documentation
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants