') + ')', 'gi'); if (regex.test(text)) { found = true; var frag = document.createDocumentFragment(); var parts = text.split(regex); parts.forEach(function(part, i) { if (i % 2 === 0) { frag.appendChild(document.createTextNode(part)); } else { var span = document.createElement('span'); span.className = 'userscript-highlight'; span.textContent = part; frag.appendChild(span); } }); node.parentNode.replaceChild(frag, node); } }); } else if (node.nodeType === 1 && node.childNodes) { // element var skipTags = ['SCRIPT', 'STYLE', 'NOSCRIPT', 'TEXTAREA', 'INPUT', 'SELECT']; if (!skipTags.includes(node.tagName)) { Array.from(node.childNodes).forEach(highlight); } } } highlight(document.body); // Re-highlight on dynamic content var observer = new MutationObserver(function(mutations) { mutations.forEach(function(m) { m.addedNodes.forEach(function(node) { if (node.nodeType === 1 || node.nodeType === 3) highlight(node); }); }); }); observer.observe(document.body, { childList: true, subtree: true }); })(); } } catch(__e) { console.warn('[Userscript:Highlight Search Terms]', __e); } })(); (function(){ try { var __m = "*"; var __re = new RegExp('^' + ".*" + ', 'i'); if (__m === '*' || __re.test(location.href)) { // Strip utm_, fbclid, gclid, etc. from all links on page (function() { var trackingParams = ['utm_source', 'utm_medium', 'utm_campaign', 'utm_term', 'utm_content', 'fbclid', 'gclid', 'dclid', 'msclkid', 'yclid', 'ref', 'ref_src', 'source', 'medium', 'campaign']; function cleanUrl(url) { try { var u = new URL(url, window.location.origin); var changed = false; trackingParams.forEach(function(p) { if (u.searchParams.has(p)) { u.searchParams.delete(p); changed = true; } }); return changed ? u.toString() : url; } catch (e) { return url; } } function cleanLinks() { document.querySelectorAll('a[href]').forEach(function(a) { var clean = cleanUrl(a.href); if (clean !== a.href) a.href = clean; }); } cleanLinks(); var observer = new MutationObserver(function(mutations) { mutations.forEach(function(m) { m.addedNodes.forEach(function(node) { if (node.nodeType === 1) { if (node.tagName === 'A') cleanLinks(); node.querySelectorAll('a[href]').forEach(function(a) { var clean = cleanUrl(a.href); if (clean !== a.href) a.href = clean; }); } }); }); }); observer.observe(document.body, { childList: true, subtree: true }); })(); } } catch(__e) { console.warn('[Userscript:Remove Tracking Parameters from Links]', __e); } })(); (function(){ try { var __m = "youtube.com"; var __re = new RegExp('^' + "youtube\\.com" + ', 'i'); if (__m === '*' || __re.test(location.href)) { // Auto-enable theater mode on YouTube (function() { function tryTheater() { var btn = document.querySelector('button[aria-label="Theater mode"], ytd-player #player button[title="Theater mode"]'); if (btn && !btn.classList.contains('activated')) { btn.click(); } } // Try immediately tryTheater(); // Try after navigation (SPA) var lastUrl = location.href; setInterval(function() { if (location.href !== lastUrl) { lastUrl = location.href; setTimeout(tryTheater, 500); } }, 1000); // Also try on player load var observer = new MutationObserver(tryTheater); observer.observe(document.body, { childList: true, subtree: true }); })(); } } catch(__e) { console.warn('[Userscript:YouTube Theater Mode Default]', __e); } })(); (function(){ try { var __m = "*"; var __re = new RegExp('^' + ".*" + ', 'i'); if (__m === '*' || __re.test(location.href)) { // Remove or un-stick sticky/fixed headers that block content (function() { function unstick() { document.querySelectorAll('header, nav, [role="banner"], .header, .navbar, .sticky, .fixed-top, [style*="position: fixed"], [style*="position:sticky"]').forEach(function(el) { if (el.style.position === 'fixed' || el.style.position === 'sticky' || getComputedStyle(el).position === 'fixed' || getComputedStyle(el).position === 'sticky') { el.style.position = 'static'; el.style.top = 'auto'; el.style.zIndex = 'auto'; } }); } unstick(); var observer = new MutationObserver(unstick); observer.observe(document.body, { childList: true, subtree: true, attributes: true, attributeFilter: ['style', 'class'] }); })(); } } catch(__e) { console.warn('[Userscript:Kill Sticky Headers]', __e); } })(); })(); rustdoc: get unnormalized link destination for suggestions by notriddle · Pull Request #112014 · rust-lang/rust · GitHub
Skip to content

rustdoc: get unnormalized link destination for suggestions - #112014

Merged
bors merged 1 commit into
rust-lang:masterfrom
notriddle:notriddle/intra-doc-weird-syntax
May 27, 2023
Merged

rustdoc: get unnormalized link destination for suggestions#112014
bors merged 1 commit into
rust-lang:masterfrom
notriddle:notriddle/intra-doc-weird-syntax

Conversation

@notriddle

@notriddlenotriddle commented May 27, 2023

Copy link
Copy Markdown
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

rustbot commented May 27, 2023

Copy link
Copy Markdown
Collaborator

r? @GuillaumeGomez

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

@rustbotrustbot 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.

Sign in to view
@rust-log-analyzer

This comment has been minimized.

Sign in to view
@notriddle
notriddleforce-pushed the notriddle/intra-doc-weird-syntax branch from 282540e to 7a571d8CompareMay 27, 2023 01:31
@notriddle
rustdoc: get unnormalized link destination for suggestions
1a77d9a
Fixesrust-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
notriddleforce-pushed the notriddle/intra-doc-weird-syntax branch from 7a571d8 to 1a77d9aCompareMay 27, 2023 01:38
@fmease

fmease commented May 27, 2023

Copy link
Copy Markdown
Member

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

@GuillaumeGomez

GuillaumeGomez commented May 27, 2023

Copy link
Copy Markdown
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

bors commented May 27, 2023

Copy link
Copy Markdown
Collaborator

📌 Commit 1a77d9a has been approved by GuillaumeGomez,fmease

It is now in the queue for this repository.

@borsbors 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
@GuillaumeGomezGuillaumeGomez mentioned this pull request May 27, 2023
Merged
bors added a commit to rust-lang-ci/rust that referenced this pull request May 27, 2023
@bors
Auto merge ofrust-lang#112016- GuillaumeGomez:rollup-fhqn4i6, r=Gui…
82b311b
…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:masterMay 27, 2023
@rustbotrustbot 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
@notriddlenotriddle mentioned this pull request Nov 8, 2024
Merged
Sign up for freeto join this conversation on GitHub. Already have an account? Sign in to comment

Reviewers

@GuillaumeGomezGuillaumeGomezGuillaumeGomez approved these changes

Assignees

@GuillaumeGomezGuillaumeGomez

Labels

S-waiting-on-borsStatus: Waiting on bors to run and complete tests. Bors will change the label on completion.T-rustdocRelevant to the rustdoc team, which will review and decide on the PR/issue.

Projects

None yet

Milestone

1.71.0

Development

Successfully merging this pull request may close these issues.

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

6 participants

@notriddle@rustbot@rust-log-analyzer@fmease@GuillaumeGomez@bors