cross-crate intra-doc failures generate a broken link instead of stripping the link #96064
Labels
A-cross-crate-reexports
Area: Documentation that has been re-exported from a different crate
A-intra-doc-links
Area: Intra-doc links, the ability to link to items in docs by name
C-bug
Category: This is a bug.
T-rustdoc
Relevant to the rustdoc team, which will review and decide on the PR/issue.
Example:
tracing-subscriber
defines theMakeWriter
trait with themake_writer
method whose docs link to theMetadata
type intracing_core
: https://docs.rs/tracing-subscriber/0.3.11/tracing_subscriber/fmt/writer/trait.MakeWriter.html#method.make_writer_fortracing-appender
has a type that implementsMakeWriter
and hence its docs reproduce the docs for the trait's methods: https://docs.rs/tracing-appender/0.2.2/tracing_appender/rolling/struct.RollingFileAppender.html#method.make_writer_forThe intra-doc link to
Metadata
didn't get resolved, and it just 404s: https://docs.rs/tracing-appender/0.2.2/tracing_appender/rolling/tracing_core::Metadata.tracing-core
isn't a direct dependency oftracing-appender
so I guess naming an item fromtracing-core
"intracing-appender
" doesn't work, even though the item is in scope where the doc comment physically exists.Those crates live in a workspace at tokio-rs/tracing.
Here's a smaller example without a workspace: https://ben0x539.github.io/intradoclinkbreakage/im/target/doc/im/struct.Im.html, from https://github.com/ben0x539/intradoclinkbreakage.
idk if this is a known limitation, and I'm currently unable to think of the right search terms to find out. Seems unfortunate though.
Meta
The text was updated successfully, but these errors were encountered: