-
Notifications
You must be signed in to change notification settings - Fork 12.9k
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.
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
Fix a few relative paths in rustc doc #130625
Merged
Merged
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
rustbot
added
S-waiting-on-review
Status: Awaiting review from the assignee but also interested parties.
T-compiler
Relevant to the compiler team, which will review and decide on the PR/issue.
labels
Sep 20, 2024
@fmease - hey! Let me know if you have time to take a quick look at the PR. Otherwise do let me know who I should bother instead to review it :D Thanks for the help! |
jieyouxu
changed the title
fix: relative paths in rustc doc #124028
Fix a few relative paths in rustc doc
Oct 10, 2024
jieyouxu
approved these changes
Oct 10, 2024
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Thanks
r? jieyouxu @bors r+ rollup |
bors
added
S-waiting-on-bors
Status: Waiting on bors to run and complete tests. Bors will change the label on completion.
and removed
S-waiting-on-review
Status: Awaiting review from the assignee but also interested parties.
labels
Oct 10, 2024
bors
added a commit
to rust-lang-ci/rust
that referenced
this pull request
Oct 10, 2024
…iaskrgr Rollup of 7 pull requests Successful merges: - rust-lang#130625 (Fix a few relative paths in rustc doc) - rust-lang#131397 (fix/update teach_note from 'escaping mutable ref/ptr' const-check) - rust-lang#131479 (Apple: Avoid redundant `-Wl,-dylib` flag when linking) - rust-lang#131480 (Fix hardcoded strip path when cross-compiling from Linux to Darwin) - rust-lang#131482 (structurally resolve adts and tuples expectations too) - rust-lang#131484 (Add myself back to review rotation) - rust-lang#131491 (impossible obligations fast path) r? `@ghost` `@rustbot` modify labels: rollup
rust-timer
added a commit
to rust-lang-ci/rust
that referenced
this pull request
Oct 10, 2024
Rollup merge of rust-lang#130625 - heiseish:issue-124028-fix, r=jieyouxu Fix a few relative paths in rustc doc ## Changes - Don't inline the doc for re-exporting some structs that have relative paths in doc. ## Context See rust-lang#124028. - Most of the relative links in rustdoc are there because of circular import (so syntax like `[MyType]: rustc_foo::bar` is difficult to achieve when we cannot import `rustc_xxx` due to circular import) - Here, I disable new links for re-exports. I think it's fine for re-exported items in `hir::*`. - There is a few more relative links in other `rustc` crates, however they are not addressed in this PR, as they are not re-exported and/so the relative paths are working. Closes rust-lang#124028. r? `@fmease` Let me know if I miss anything or there's any other way to address this issue.
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Labels
S-waiting-on-bors
Status: Waiting on bors to run and complete tests. Bors will change the label on completion.
T-compiler
Relevant to the compiler team, which will review and decide on the PR/issue.
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Changes
Context
See #124028.
[MyType]: rustc_foo::bar
is difficult to achieve when we cannot importrustc_xxx
due to circular import)hir::*
.rustc
crates, however they are not addressed in this PR, as they are not re-exported and/so the relative paths are working.Closes #124028.
r? @fmease
Let me know if I miss anything or there's any other way to address this issue.