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

Oudated html_root_url for compiler crates #77103

Closed
bjorn3 opened this issue Sep 23, 2020 · 2 comments · Fixed by #77121
Closed

Oudated html_root_url for compiler crates #77103

bjorn3 opened this issue Sep 23, 2020 · 2 comments · Fixed by #77121
Assignees
@duckymirror
Labels
A-docs Area: documentation for any part of the project, including the compiler, standard library, and tools E-easy Call for participation: Easy difficulty. Experience needed to fix: Not much. Good first issue. E-mentor Call for participation: This issue has a mentor. Use #t-compiler/help on Zulip for discussion. T-compiler Relevant to the compiler team, which will review and decide on the PR/issue.

Comments

@bjorn3
Copy link
Member

bjorn3 commented Sep 23, 2020 •
edited by rustbot
Loading

https://doc.rust-lang.org/nightly/ should be https://doc.rust-lang.org/nightly/nightly-rustc/
@jonas-schievink jonas-schievink added E-easy Call for participation: Easy difficulty. Experience needed to fix: Not much. Good first issue. T-compiler Relevant to the compiler 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 Sep 23, 2020
@jyn514
Copy link
Member

jyn514 commented Sep 23, 2020 •
edited
Loading

Mentoring instructions: for each crate in compiler/, change

rust/compiler/rustc_apfloat/src/lib.rs

Line 33 in 9e5f7d5

#![doc(html_root_url = "https://doc.rust-lang.org/nightly/")]

to say #![doc(html_root_url = "https://doc.rust-lang.org/nightly/nightly-rustc")] instead. You can probably automate this with fd and sed. You can test your changes by running x.py check to make sure the syntax is valid or x.py doc to make sure the generated HTML is correct. Make sure to set compiler-docs = true in config.toml.

@jyn514 jyn514 added the E-mentor Call for participation: This issue has a mentor. Use #t-compiler/help on Zulip for discussion. label Sep 23, 2020
@duckymirror
Copy link
Contributor

@rustbot claim

@duckymirror duckymirror mentioned this issue Sep 23, 2020
Merged
@bors bors closed this as completed in 6f3da3d Sep 25, 2020
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees

@duckymirror duckymirror

Labels
A-docs Area: documentation for any part of the project, including the compiler, standard library, and tools E-easy Call for participation: Easy difficulty. Experience needed to fix: Not much. Good first issue. E-mentor Call for participation: This issue has a mentor. Use #t-compiler/help on Zulip for discussion. T-compiler Relevant to the compiler 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.

Updated html_root_url for compiler crates duckymirror/rust
4 participants
@jonas-schievink @bjorn3 @jyn514 @duckymirror