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.

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

Jump to bottom

Auto-linking can fail for implicit links #83

Closed
dmurdoch opened this issue Mar 25, 2021 · 1 comment · Fixed by r-lib/pkgdown#1586
Closed

Auto-linking can fail for implicit links #83

dmurdoch opened this issue Mar 25, 2021 · 1 comment · Fixed by r-lib/pkgdown#1586

Comments

@dmurdoch
Copy link
Contributor

dmurdoch commented Mar 25, 2021 •
edited

The link to the planes3d function in the vignette here:

https://github.com/dmurdoch/rgl/blob/46f8972f6e1baec81b3d492026ee353102e88f11/dev/articles/pkgdown.html#L140

is incorrect. The topic planes3d appears in the planes.Rd file, not planes3d.Rd, so the link should have <a href="../reference/planes.html"> instead of <a href="../reference/planes3d.html">.

I believe I know where the problem happens; I'll see if I can fix it and submit a PR.
@dmurdoch
Copy link
Contributor Author

The trigger for this seems to be that the planes.Rd file starts with \name{planes3d}. The link is generated based on the \name value, while the output file is named according to the filename.

@dmurdoch dmurdoch mentioned this issue Mar 25, 2021
Merged
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees
No one assigned
Labels
None yet
Projects
None yet
Milestone
No milestone
Development

Successfully merging a pull request may close this issue.

The \name{} field in an Rd file shouldn't be used in the topic index dmurdoch/pkgdown
1 participant
@dmurdoch