Move to slightly better location; tweak implementation a little

hadley · hadley · commit 2f5c40b4f07d · 2025-10-17T13:14:26.000-05:00
diff --git a/NEWS.md b/NEWS.md
@@ -1,5 +1,6 @@
 # pkgdown (development version)
 
+* Links generated with `\code{\link{foo}()}` now have the `()` moved into the `<a>` in the generated output (@maelle).
 * Plots in dark mode are now transformed with a CSS filter to improve their
   visibility (thanks to @gadenbuie).
 * Updated the translations vignette with instructions for building non-English sites through Github Actions.
diff --git a/R/tweak-page.R b/R/tweak-page.R
@@ -17,6 +17,7 @@ tweak_page <- function(html, name, pkg = list(bs_version = 3)) {
 
   tweak_anchors(html)
   tweak_link_md(html)
+  tweak_link_seealso(html)
   tweak_link_external(html, pkg = pkg)
   tweak_img_src(html)
   tweak_strip(html, !identical(pkg$development$mode, "release"))
diff --git a/R/tweak-reference.R b/R/tweak-reference.R
@@ -23,19 +23,6 @@ tweak_reference_highlighting <- function(html) {
   # Add div.sourceCode for copy button
   xml2::xml_add_parent(pre[!handled], "div", class = "sourceCode")
 
-  # Fix seealso links
-  seealso_links <- xml2::xml_find_all(
-    html,
-    "//code[a and text() = '()']"
-  )
-  seealso_kids <- xml2::xml_children(seealso_links)
-  xml2::xml_text(seealso_kids) <- paste0(xml2::xml_text(seealso_kids), "()")
-  text_nodes <- xml2::xml_find_all(
-    seealso_links,
-    "./text()[normalize-space(.) = '()']"
-  )
-  xml2::xml_remove(text_nodes)
-
   invisible()
 }
 
diff --git a/R/tweak-tags.R b/R/tweak-tags.R
@@ -167,6 +167,21 @@ tweak_link_R6 <- function(html, cur_package) {
   invisible()
 }
 
+# Fix seealso links
+tweak_link_seealso <- function(html) {
+  seealso_links <- xml2::xml_find_all(html, "//code[a and text() = '()']")
+
+  # add () inside link
+  seealso_text <- xml2::xml_children(seealso_links)
+  xml2::xml_text(seealso_text) <- paste0(xml2::xml_text(seealso_text), "()")
+
+  # remove () outside the link
+  text_nodes <- xml2::xml_find_all(seealso_links, "./text()[. = '()']")
+  xml2::xml_remove(text_nodes)
+
+  invisible()
+}
+
 tweak_tables <- function(html) {
   # Ensure all tables have class="table" apart from arguments
   table <- xml2::xml_find_all(html, ".//table")
diff --git a/tests/testthat/test-tweak-reference.R b/tests/testthat/test-tweak-reference.R
@@ -141,17 +141,6 @@ test_that("can highlight 'rmd'", {
   expect_equal(xpath_attr(html, "//code//span[not(span)]", "class")[[1]], "an")
 })
 
-test_that("fix seealso links", {
-  skip_if_no_pandoc("2.16")
-  html <- xml2::read_html('<code><a>build_site</a>()</code>')
-  tweak_reference_highlighting(html)
-
-  expect_equal(
-    as.character(xml2::xml_child(html)),
-    "<body><code><a>build_site()</a></code></body>"
-  )
-})
-
 test_that("fails cleanly", {
   html <- xml2::read_xml('<div><pre><code></code></pre></div>')
   tweak_highlight_other(html)
diff --git a/tests/testthat/test-tweak-tags.R b/tests/testthat/test-tweak-tags.R
@@ -262,6 +262,14 @@ test_that("tweak_img_src() doesn't modify absolute links", {
   )
 })
 
+test_that("trailing () moved inside links", {
+  skip_if_no_pandoc("2.16")
+  html <- xml2::read_html('<code><a>build_site</a>()</code>')
+  tweak_link_seealso(html)
+
+  expect_equal(xpath_contents(html, ".//code"), "<a>build_site()</a>")
+})
+
 # stripped divs etc -------------------------------------------------------
 
 test_that("selectively remove hide- divs", {
