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

Links to topics starting with period not working #1501

Closed
ManuelHentschel opened this issue Feb 16, 2021 · 2 comments
Closed

Links to topics starting with period not working #1501

ManuelHentschel opened this issue Feb 16, 2021 · 2 comments

Comments

@ManuelHentschel
Copy link

If a topic/function name starts with a period, the links to its page seem to be broken. In the following example

#' Example 1
#' 
#' @seealso [.f3()]
#' @family test
#' @export
.f1 <- function() NULL


#' Example 2
#' 
#' @family test
#' @export
.f2 <- function() NULL


#' Example 3
#' 
#' @export
.f3 <- function() NULL

the names of the generated help pages are e.g.
/docs/reference/dot-f2.html
but the hyperlinks in the see also-section of .f1 point to
/docs/reference/.f2.html,
resulting in an error when trying to follow the link. The hyperlinks on /docs/reference/index.html point to the correct addresses.

The html from the integrated R help server also points to the "wrong" adress, but this seems to be no issue, since the server automatically replaces the leading . with dot-.

As a workaround, manually specifying @name dot-f1 seems to work, but this adds extra entries to the help index (and the redundant @name tags), so I'd rather avoid this.

@maelle
Copy link
Collaborator

maelle commented May 7, 2021

I wonder whether this has been fixed by #1586

@maelle
Copy link
Collaborator

maelle commented May 7, 2021

From quick local tests it seems so (so, in the dev version of pkgdown), please feel free to comment if I missed something @ManuelHentschel. 🙂

@maelle maelle closed this as completed May 7, 2021
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

No branches or pull requests

2 participants