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

rustdoc: get unnormalized link destination for suggestions #112014

Merged
merged 1 commit into from
May 27, 2023

Conversation

notriddle
Copy link
Contributor

Fixes #110111

This bug, and the workaround in this PR, is closely linked to raphlinus/pulldown-cmark#441, getting offsets of link components. In particular, pulldown-cmark doesn't provide the offsets of the contents of a link.

To work around this, rustdoc parser parts of a link definition itself.

@rustbot
Copy link
Collaborator

rustbot commented May 27, 2023

r? @GuillaumeGomez

(rustbot has picked a reviewer for you, use r? to override)

@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 May 27, 2023
@rust-log-analyzer

This comment has been minimized.

@rust-log-analyzer

This comment has been minimized.

@notriddle notriddle force-pushed the notriddle/intra-doc-weird-syntax branch from 282540e to 7a571d8 Compare May 27, 2023 01:31
Fixes rust-lang#110111

This bug, and the workaround in this commit, is closely linked to
[pulldown-cmark/pulldown-cmark#441], getting offsets of link
components. In particular, pulldown-cmark doesn't provide the
offsets of the contents of a link.

To work around this, rustdoc parser parts of a link definition
itself.

[pulldown-cmark/pulldown-cmark#441]: pulldown-cmark/pulldown-cmark#441
@notriddle notriddle force-pushed the notriddle/intra-doc-weird-syntax branch from 7a571d8 to 1a77d9a Compare May 27, 2023 01:38
@fmease
Copy link
Member

fmease commented May 27, 2023

Thanks for taking over! I got too frustrated trying to fix this

@GuillaumeGomez
Copy link
Member

Thanks for the PR!

@fmease: yes it's a bit annoying. I'm still hoping that at some point, pulldown-cmark will provide the offset information. It would make things much simpler to handle.

@bors: r=GuillaumeGomez,fmease rollup

@bors
Copy link
Contributor

bors commented May 27, 2023

📌 Commit 1a77d9a has been approved by GuillaumeGomez,fmease

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 May 27, 2023
bors added a commit to rust-lang-ci/rust that referenced this pull request May 27, 2023
…llaumeGomez

Rollup of 6 pull requests

Successful merges:

 - rust-lang#111936 (Include test suite metadata in the build metrics)
 - rust-lang#111952 (Remove DesugaringKind::Replace.)
 - rust-lang#111966 (Add #[inline] to array TryFrom impls)
 - rust-lang#111983 (Perform MIR type ops locally in new solver)
 - rust-lang#111997 (Fix re-export of doc hidden macro not showing up)
 - rust-lang#112014 (rustdoc: get unnormalized link destination for suggestions)

r? `@ghost`
`@rustbot` modify labels: rollup
@bors bors merged commit 3089653 into rust-lang:master May 27, 2023
11 checks passed
@rustbot rustbot added this to the 1.71.0 milestone May 27, 2023
@notriddle notriddle deleted the notriddle/intra-doc-weird-syntax branch May 27, 2023 15:37
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.

Issues with intra-doc links to core/std derive macros
6 participants