roxygen2 icon indicating copy to clipboard operation
roxygen2 copied to clipboard

URL escape characters from package DESCRIPTION are not escaped for .Rd

Open HenningLorenzen-ext-bayer opened this issue 3 years ago • 0 comments

Steps to reproduce

  • Example DESCRIPTION file
Package: foobar.test.roxygen2
Type: Package
Title: What the Package Does (Title Case)
Version: 0.1.0
Author: Who wrote it
Maintainer: The package maintainer <[email protected]>
Description: More about what it does (maybe more than one line)
    Use four spaces when indenting paragraphs within the Description.
License: What license is it under?
Encoding: UTF-8
LazyData: true
URL: https://www.google.com/search?q=foo%20bar
BugReports: https://www.google.com/search?q=bug%20reports
RoxygenNote: 7.2.0
  • usethis::use_package_doc()

  • Run devtools::check_man()

Result

ℹ Updating foobar.test.roxygen2 documentation
ℹ Loading foobar.test.roxygen2
ℹ Checking documentation...
prepare_Rd: [left out for privacy]/foobar.test.roxygen2/man/foobar.test.roxygen2-package.Rd:19: unexpected section header '\keyword'
prepare_Rd: [left out for privacy]/foobar.test.roxygen2/man/foobar.test.roxygen2-package.Rd:20: unexpected END_OF_INPUT '
'
✔ No issues detected

Contents of .Rd file

% Generated by roxygen2: do not edit by hand
% Please edit documentation in R/foobar.test.roxygen2-package.R
\docType{package}
\name{foobar.test.roxygen2-package}
\alias{foobar.test.roxygen2}
\alias{foobar.test.roxygen2-package}
\title{foobar.test.roxygen2: What the Package Does (Title Case)}
\description{
More about what it does (maybe more than one line) Use four spaces when indenting paragraphs within the Description.
}
\seealso{
Useful links:
\itemize{
  \item \url{https://www.google.com/search?q=foo%20bar}
  \item Report bugs at \url{https://www.google.com/search?q=bug%20reports}
}

}
\keyword{internal}