Skip to content

Commit

Permalink
Auto merge of rust-lang#16385 - Urhengulas:fix-tra-doc-links, r=Veykril
Browse files Browse the repository at this point in the history
Fix intra doc links

Fixes rust-lang#15848
  • Loading branch information
bors committed Jan 18, 2024
2 parents a5b89ff + c817286 commit 6d31416
Show file tree
Hide file tree
Showing 2 changed files with 38 additions and 8 deletions.
20 changes: 12 additions & 8 deletions crates/ide/src/doc_links.rs
Original file line number Diff line number Diff line change
Expand Up @@ -64,13 +64,12 @@ pub(crate) fn rewrite_links(db: &RootDatabase, markdown: &str, definition: Defin
// * path-based links: `../../module/struct.MyStruct.html`
// * module-based links (AKA intra-doc links): `super::super::module::MyStruct`
if let Some((target, title)) = rewrite_intra_doc_link(db, definition, target, title) {
return (None, target, title);
}
if let Some(target) = rewrite_url_link(db, definition, target) {
return (Some(LinkType::Inline), target, title.to_string());
(None, target, title)
} else if let Some(target) = rewrite_url_link(db, definition, target) {
(Some(LinkType::Inline), target, title.to_string())
} else {
(None, target.to_string(), title.to_string())
}

(None, target.to_string(), title.to_string())
}
});
let mut out = String::new();
Expand Down Expand Up @@ -369,16 +368,21 @@ fn rewrite_intra_doc_link(
) -> Option<(String, String)> {
let (link, ns) = parse_intra_doc_link(target);

let (link, anchor) = match link.split_once('#') {
Some((new_link, anchor)) => (new_link, Some(anchor)),
None => (link, None),
};

let resolved = resolve_doc_path_for_def(db, def, link, ns)?;
let mut url = get_doc_base_urls(db, resolved, None, None).0?;

let (_, file, frag) = filename_and_frag_for_def(db, resolved)?;
let (_, file, _) = filename_and_frag_for_def(db, resolved)?;
if let Some(path) = mod_path_of_def(db, resolved) {
url = url.join(&path).ok()?;
}

url = url.join(&file).ok()?;
url.set_fragment(frag.as_deref());
url.set_fragment(anchor);

Some((url.into(), strip_prefixes_suffixes(title).to_string()))
}
Expand Down
26 changes: 26 additions & 0 deletions crates/ide/src/doc_links/tests.rs
Original file line number Diff line number Diff line change
Expand Up @@ -664,3 +664,29 @@ pub struct $0Foo;
expect![["[`foo`]"]],
);
}

#[test]
fn rewrite_intra_doc_link() {
check_rewrite(
r#"
//- minicore: eq, derive
//- /main.rs crate:foo
//! $0[PartialEq]
fn main() {}
"#,
expect!["[PartialEq](https://doc.rust-lang.org/stable/core/cmp/trait.PartialEq.html)"],
);
}

#[test]
fn rewrite_intra_doc_link_with_anchor() {
check_rewrite(
r#"
//- minicore: eq, derive
//- /main.rs crate:foo
//! $0[PartialEq#derivable]
fn main() {}
"#,
expect!["[PartialEq#derivable](https://doc.rust-lang.org/stable/core/cmp/trait.PartialEq.html#derivable)"],
);
}

0 comments on commit 6d31416

Please sign in to comment.