-
-
Notifications
You must be signed in to change notification settings - Fork 14.8k
Consider warning when intra-doc links fail on a cross-crate re-export #77200
Copy link
Copy link
Closed
Labels
A-cross-crate-reexportsArea: Documentation that has been re-exported from a different crateArea: Documentation that has been re-exported from a different crateA-intra-doc-linksArea: Intra-doc links, the ability to link to items in docs by nameArea: Intra-doc links, the ability to link to items in docs by nameI-needs-decisionIssue: In need of a decision.Issue: In need of a decision.T-rustdocRelevant to the rustdoc team, which will review and decide on the PR/issue.Relevant to the rustdoc team, which will review and decide on the PR/issue.
Metadata
Metadata
Assignees
Labels
A-cross-crate-reexportsArea: Documentation that has been re-exported from a different crateArea: Documentation that has been re-exported from a different crateA-intra-doc-linksArea: Intra-doc links, the ability to link to items in docs by nameArea: Intra-doc links, the ability to link to items in docs by nameI-needs-decisionIssue: In need of a decision.Issue: In need of a decision.T-rustdocRelevant to the rustdoc team, which will review and decide on the PR/issue.Relevant to the rustdoc team, which will review and decide on the PR/issue.
Type
Fields
Give feedbackNo fields configured for issues without a type.
This is the exact opposite of #56922 😆
There have been a lot of silent failures popping up WRT cross-crate re-exports (#77193, #75855, #76106), and they're hard to notice because the failure is completely swallowed, you have to manually inspect the generated docs.
The rationale in #56922 was that
This is only true if the failure existed in the upstream crate. If it only appears on the re-export, it will fail completely silently for both the original crate and the current one. This is especially bad when you're adding additional docs on the re-export:
It could also appear for things outside of the control of the new crate, though: #75855
I think it also makes sense to warn for rustdoc bugs, since otherwise the user never knows to report them and we can't fix them.
@rust-lang/rustdoc what do you think?
cc @euclio