Skip to content

feat: put parentheses inside seealso links #2922

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.

Sign up for GitHub

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

Merged
hadley merged 6 commits into from
Oct 17, 2025
Merged

feat: put parentheses inside seealso links #2922

Show file tree
Hide file tree
Changes from 2 commits
Commits
Show all changes
6 commits
Select commit Hold shift + click to select a range
94c7d70
feat: put parentheses inside seealso links
maelle Oct 13, 2025
9609faa
test: test for seealso fixing
maelle Oct 13, 2025
09c8aa0
Update R/tweak-reference.R
maelle Oct 16, 2025
7ba073c
Update tests/testthat/test-tweak-reference.R
maelle Oct 16, 2025
ab73fd3
rm useless
maelle Oct 16, 2025
2f5c40b
Move to slightly better location; tweak implementation a little
hadley Oct 17, 2025
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
12 changes: 12 additions & 0 deletions R/tweak-reference.R
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -23,6 +23,18 @@ 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 normalize-space(text()) = '()']"
Copy link
Member

@hadley hadley Oct 14, 2025

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Are you sure you need the normalize-space here? I would think that it would be pretty unusually to have extra whitespace here.

)
seealso_kids <- xml2::xml_children(seealso_links)
xml2::xml_text(seealso_kids) <- paste0(xml2::xml_text(seealso_kids), "()")
purrr::walk(seealso_links, \(x) {
text_nodes <- xml2::xml_find_all(x, "./text()[normalize-space(.) = '()']")
xml2::xml_remove(text_nodes)
})

invisible()
}

Expand Down
13 changes: 13 additions & 0 deletions tests/testthat/test-tweak-reference.R
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -141,6 +141,19 @@ 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)
Expand Down