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

URL from person(comment = "") not shown on authors page #93

Closed
dpprdan opened this issue Jun 10, 2022 · 2 comments · Fixed by r-lib/pkgdown#2127
Closed

URL from person(comment = "") not shown on authors page #93

dpprdan opened this issue Jun 10, 2022 · 2 comments · Fixed by r-lib/pkgdown#2127
Assignees

Comments

@dpprdan
Copy link

dpprdan commented Jun 10, 2022

The devguide suggests to add reviewers to the authors@R field of the DESCRIPTION like so

    person("Bea", "Hernández", role = "rev",
    comment = "Bea reviewed the package (v. X.X.XX) for rOpenSci, see <https://github.com/ropensci/software-review/issues/116>"),

in particular, to add the URL of the review issue in the person(comment) field with angle brackets.

Unfortunately the URL is not shown on the authors.html page on docs.ropensci.org. See for example https://docs.ropensci.org/opencage/authors.html

grafik

The URL is shown for some other packages (as text, not as a hyperlink), like bikedata or stplanr, but only because they do not use angle brackets, see bikedata's DESCRIPTION.

Apparently this gets by CRAN's bouncers at the moment as stplanr just updated on CRAN. However, WRE demands angle brackets for URL in other DESCRIPTION fields, so I assume they might be less lenient in the future.

I suspect that the URL is parsed as an HTML tag because of the angle brackets? Is this something that can be fixed in rotemplate or is this an upstream, i.e. pkgdown issue?

@maelle maelle self-assigned this Jun 14, 2022
@maelle
Copy link
Contributor

maelle commented Jun 14, 2022

Related r-lib/pkgdown#1205

@maelle
Copy link
Contributor

maelle commented Jun 15, 2022

Note that this will only be really fixed once pkgdown is released on CRAN and rOpenSci build system has been updated so it might be a little while.

Thanks a ton for the bug report @dpprdan! 🙏

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging a pull request may close this issue.

2 participants