Skip to content

#![forbid(rustdoc::broken_intra_doc_links)]#10597

Closed
stepancheg wants to merge 1 commit into
bevyengine:mainfrom
stepancheg:forbid-broken-intra-doc-links
Closed

#![forbid(rustdoc::broken_intra_doc_links)]#10597
stepancheg wants to merge 1 commit into
bevyengine:mainfrom
stepancheg:forbid-broken-intra-doc-links

Conversation

@stepancheg

Copy link
Copy Markdown
Contributor

Safer this way.

@hymm

hymm commented Nov 16, 2023

Copy link
Copy Markdown
Contributor

This should probably wait for #10011 and then use workspace lints.

@alice-i-cecile alice-i-cecile added C-Docs An addition or correction to our documentation A-Build-System Related to build systems or continuous integration labels Nov 16, 2023
@alice-i-cecile

Copy link
Copy Markdown
Member

On board with this, but swap it to a warn and do it at the workspace level like WrongShoe said :)

@stepancheg

Copy link
Copy Markdown
Contributor Author

swap it to a warn

It is warn by default. So when I run cargo doc, it just prints a warning which is too easy to overlook.

@mockersf

Copy link
Copy Markdown
Member

CI will already fail on doc warnings, no need to forbid it

@alice-i-cecile

Copy link
Copy Markdown
Member

Let's leave it as is then.

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.

4 participants