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

Add jump to doc #113623

Merged
merged 2 commits into from
Jul 13, 2023
Merged

Add jump to doc #113623

merged 2 commits into from
Jul 13, 2023

Conversation

GuillaumeGomez
Copy link
Member

@GuillaumeGomez GuillaumeGomez commented Jul 12, 2023

I'm using the source code pages of the compiler quite a lot, but one thing missing is the possibility to jump back from the source code to the item documentation. Since I also got a few others complaining about it, I think it's fine to add it since this option is nightly only.

This PR adds a link to jump back to item's documentation on the item definition (so on Bar in struct Bar {... }, as described in the unofficial RFC).

r? @notriddle

@rustbot rustbot added S-waiting-on-review Status: Awaiting review from the assignee but also interested parties. T-rustdoc Relevant to the rustdoc team, which will review and decide on the PR/issue. labels Jul 12, 2023
@notriddle
Copy link
Contributor

@bors r+ rollup

Since benchmarks don't run with source links turned on, this probably won't have any visible perf effect, even though it's obviously doing more work.

@bors
Copy link
Contributor

bors commented Jul 13, 2023

📌 Commit 6d44879 has been approved by notriddle

It is now in the queue for this repository.

@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 Jul 13, 2023
matthiaskrgr added a commit to matthiaskrgr/rust that referenced this pull request Jul 13, 2023
…notriddle

Add jump to doc

I'm using the source code pages of the compiler quite a lot, but one thing missing is the possibility to jump back from the source code to the item documentation. Since I also got a few others complaining about it, I think it's fine to add it since this option is nightly only.

This PR adds a link to jump back to item's documentation on the item definition (so on `Bar` in `struct Bar {... }`, as described in the unofficial [RFC](https://github.com/GuillaumeGomez/rfcs/blob/rustdoc-jump-to-definition/text/000-rustdoc-jump-to-definition.md)).

r? `@notriddle`
matthiaskrgr added a commit to matthiaskrgr/rust that referenced this pull request Jul 13, 2023
…notriddle

Add jump to doc

I'm using the source code pages of the compiler quite a lot, but one thing missing is the possibility to jump back from the source code to the item documentation. Since I also got a few others complaining about it, I think it's fine to add it since this option is nightly only.

This PR adds a link to jump back to item's documentation on the item definition (so on `Bar` in `struct Bar {... }`, as described in the unofficial [RFC](https://github.com/GuillaumeGomez/rfcs/blob/rustdoc-jump-to-definition/text/000-rustdoc-jump-to-definition.md)).

r? ``@notriddle``
matthiaskrgr added a commit to matthiaskrgr/rust that referenced this pull request Jul 13, 2023
…notriddle

Add jump to doc

I'm using the source code pages of the compiler quite a lot, but one thing missing is the possibility to jump back from the source code to the item documentation. Since I also got a few others complaining about it, I think it's fine to add it since this option is nightly only.

This PR adds a link to jump back to item's documentation on the item definition (so on `Bar` in `struct Bar {... }`, as described in the unofficial [RFC](https://github.com/GuillaumeGomez/rfcs/blob/rustdoc-jump-to-definition/text/000-rustdoc-jump-to-definition.md)).

r? ```@notriddle```
bors added a commit to rust-lang-ci/rust that referenced this pull request Jul 13, 2023
…iaskrgr

Rollup of 6 pull requests

Successful merges:

 - rust-lang#113536 (avoid building proof trees in select)
 - rust-lang#113558 (Only use max_line_length = 100 for *.rs)
 - rust-lang#113570 (refactor proof tree formatting)
 - rust-lang#113623 (Add jump to doc)
 - rust-lang#113629 (Add Adt to SMIR)
 - rust-lang#113631 (make MCP510 behavior opt-in to avoid conflicts between the CLI and target flavors)

r? `@ghost`
`@rustbot` modify labels: rollup
@bors bors merged commit 3614611 into rust-lang:master Jul 13, 2023
11 checks passed
@rustbot rustbot added this to the 1.73.0 milestone Jul 13, 2023
@GuillaumeGomez GuillaumeGomez deleted the add-jump-to-doc branch July 14, 2023 12:51
bors added a commit to rust-lang-ci/rust that referenced this pull request Jul 15, 2023
…ocation-handling, r=lqd

Remove unneeded handling for `ExternalLocation::Unknown` in rustdoc render context

Should fix perf regression introduced in rust-lang#113623.

r? `@lqd`
github-actions bot pushed a commit to rust-lang/miri that referenced this pull request Jul 16, 2023
…andling, r=lqd

Remove unneeded handling for `ExternalLocation::Unknown` in rustdoc render context

Should fix perf regression introduced in rust-lang/rust#113623.

r? `@lqd`
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-rustdoc Relevant to the rustdoc team, which will review and decide on the PR/issue.
Projects
None yet
Development

Successfully merging this pull request may close these issues.

4 participants