Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

rustdoc generates cross-crate links to pages which don't exist because of #[doc(hidden)] #28480

Closed
eefriedman opened this issue Sep 18, 2015 · 2 comments · Fixed by #33002
Closed

rustdoc generates cross-crate links to pages which don't exist because of #[doc(hidden)] #28480

eefriedman opened this issue Sep 18, 2015 · 2 comments · Fixed by #33002
Labels
T-rustdoc Relevant to the rustdoc team, which will review and decide on the PR/issue.

Comments

@eefriedman
Copy link
Contributor

For example, https://doc.rust-lang.org/nightly/std/fmt/struct.Formatter.html#method.align links to https://doc.rust-lang.org/nightly/core/fmt/rt/v1/enum.Alignment.html, which doesn't exist because std::fmt::rt is marked #[doc(hidden)] .
@eefriedman
Copy link
Contributor Author

Related: https://doc.rust-lang.org/nightly/std/fmt/trait.Debug.html links to https://doc.rust-lang.org/nightly/core/num/flt2dec/bignum/struct.Big32x40.html, which doesn't exist because it isn't a public type.

@steveklabnik steveklabnik added the T-rustdoc Relevant to the rustdoc team, which will review and decide on the PR/issue. label Sep 28, 2015
@mitaa
Copy link
Contributor

mitaa commented Apr 7, 2016

These instances have been fixed, but the underlying problem is IIRC still present. (#31948, 8aa268e)

@mitaa mitaa mentioned this issue Apr 17, 2016
Merged
bors added a commit that referenced this issue Apr 19, 2016
@bors
Auto merge of #33002 - mitaa:rdoc-cross-impls, r=alexcrichton
478a33d 
rustdoc: refine cross-crate impl inlining

This changes the current rule that impls within `doc(hidden)` modules aren't inlined, to only inlining impls where the implemented trait and type are reachable in documentation.

fixes #14586
fixes #31948

.. and also applies the reachability checking to cross-crate links.

fixes #28480

r? @alexcrichton
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees
No one assigned
Labels
T-rustdoc Relevant to the rustdoc team, which will review and decide on the PR/issue.
Projects
None yet
Milestone
No milestone
Development

Successfully merging a pull request may close this issue.

rustdoc: refine cross-crate impl inlining mitaa/rust
3 participants
@steveklabnik @mitaa @eefriedman