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 links to private mod: pub use self::private::Enum::* #46767

Closed
MaloJaffre opened this issue Dec 16, 2017 · 1 comment
Closed

Rustdoc links to private mod: pub use self::private::Enum::* #46767

MaloJaffre opened this issue Dec 16, 2017 · 1 comment
Labels
A-docs Area: documentation for any part of the project, including the compiler, standard library, and tools T-rustdoc Relevant to the rustdoc team, which will review and decide on the PR/issue.

Comments

@MaloJaffre
Copy link
Contributor

MaloJaffre commented Dec 16, 2017 •
edited
Loading 

mod private {
    pub enum Enum{Variant}
} 
pub use self::private::Enum::*;

Rustdoc renders the use with a broken link for private:
<a class="mod" href="./private/index.html">private</a>

rustc 1.24.0-nightly (77efd6800 2017-12-15)
binary: rustc
commit-hash: 77efd6800c57ba83923dddbbabf03c7afa6a34a4
commit-date: 2017-12-15
host: x86_64-unknown-linux-gnu
release: 1.24.0-nightly
LLVM version: 4.0
@MaloJaffre MaloJaffre changed the title Rustdoc links to private mod: pub use self::private::Enum::Variant Rustdoc links to private mod: pub use self::private::Enum::* Dec 16, 2017
@MaloJaffre MaloJaffre mentioned this issue Dec 16, 2017
Merged
10 tasks
@GuillaumeGomez GuillaumeGomez added T-rustdoc Relevant to the rustdoc team, which will review and decide on the PR/issue. A-docs Area: documentation for any part of the project, including the compiler, standard library, and tools labels Dec 18, 2017
@GuillaumeGomez
Copy link
Member

Strange that it add the private part...

@ollie27 ollie27 mentioned this issue Dec 28, 2017
Merged
bors added a commit that referenced this issue Dec 29, 2017
@bors
Auto merge of #47050 - ollie27:rustdoc_import_links, r=QuietMisdreavus
ec9be91 
rustdoc: Don't try to generate links for modules in import paths

The modules may be private or may even be enums so it would generate dead links.

Fixes #29814
Fixes #46766
Fixes #46767
bors added a commit that referenced this issue Jan 1, 2018
@bors
Auto merge of #46278 - MaloJaffre:ci-compiler-docs, r=kennytm
5deba22 
Add compiler docs testing to CI.

Fixes #47025.
I don't know if `x86_64-gnu` is the right builder for this, but there seems to be time left on [Travis](https://travis-ci.org/rust-lang/rust/jobs/307488864).

Remaining problems blocking this PR:
- [x] broken links caused by rustdoc issues:
  - [x] `pub use self::Enum::...`: #46766 and #46767 (fixed by #47050, thanks @ollie27!)
  - [x] `impl Deref for DerefToStdType`: #32129 (ignored in linkchecker)
  - [x] `#[feature(decl_macro)]` and `use std::vec`: #47038 (ignored in linkchecker)
  - [x]  `rustc_data_structures::sync::{Lrc, RwLock}` aliases `std` types: #32130 (ignored in linkchecker)
- [x] markdown differences, in rust repository and in external crates, now failing the build with #46880 merged (all fixed)
- [x] multiple crate updates needed: `rand`, `log`, `parking_lot_core`, `flate2`
  - [x] submodule updates needed to deduplicate dependencies: `rust-installer`, ~`cargo`~ (done by #47052)
  - [x] #44953 test broken by `log` update (removed, this can be controversial)
- [x] Waiting `x86_64-gnu` build results ([done](https://travis-ci.org/rust-lang/rust/builds/323451069))

See individual commits for more details.
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees
No one assigned
Labels
A-docs Area: documentation for any part of the project, including the compiler, standard library, and tools T-rustdoc Relevant to the rustdoc team, which will review and decide on the PR/issue.
Projects
None yet
Milestone
No milestone
Development

No branches or pull requests
2 participants
@GuillaumeGomez @MaloJaffre