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.

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 2 commits into from
Oct 10, 2024
Merged

Conversation

heiseish
Copy link
Contributor

@heiseish heiseish commented Sep 20, 2024

Changes

  • Don't inline the doc for re-exporting some structs that have relative paths in doc.

Context

See #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 #124028.

r​? @fmease

Let me know if I miss anything or there's any other way to address this issue.

@rustbot
Copy link
Collaborator

rustbot commented Sep 20, 2024

r? @cjgillot

rustbot has assigned @cjgillot.
They will have a look at your PR within the next two weeks and either review your PR or reassign to another reviewer.

Use r? to explicitly pick a reviewer

@rustbot 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
@cjgillot cjgillot assigned fmease and unassigned cjgillot Sep 21, 2024
@heiseish
Copy link
Contributor Author

@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 jieyouxu changed the title fix: relative paths in rustc doc #124028 Fix a few relative paths in rustc doc Oct 10, 2024
Copy link
Member

@jieyouxu jieyouxu left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Thanks

@jieyouxu
Copy link
Member

r? jieyouxu @bors r+ rollup

@bors
Copy link
Contributor

bors commented Oct 10, 2024

📌 Commit ff86fa5 has been approved by jieyouxu

It is now in the queue for this repository.

@rustbot rustbot assigned jieyouxu and unassigned fmease Oct 10, 2024
@bors 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
@bors bors merged commit 6d41be2 into rust-lang:master Oct 10, 2024
6 checks passed
@rustbot rustbot added this to the 1.83.0 milestone Oct 10, 2024
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.
Projects
None yet
Development

Successfully merging this pull request may close these issues.

Do not use relative path in rustc doc
6 participants