search

ropensci-org / rotemplate

pkgdown template for rOpenSci packages :nail_care: :sparkles:
https://docs.ropensci.org/rotemplate
Other
25 stars 6 forks source link

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

Closed dpprdan closed 2 years ago

dpprdan commented 2 years ago

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 commented 2 years ago

Related https://github.com/r-lib/pkgdown/issues/1205

maelle commented 2 years ago

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! :pray: