search

GeoBosh / Rdpack

R package Rdpack provides functions and macros facilitating writing and management of R documentation.
https://geobosh.github.io/Rdpack/
28 stars 6 forks source link

Superlfuous escaped LaTeX specials #26

Closed GeoBosh closed 2 years ago

GeoBosh commented 2 years ago

Recently (beginning of June 2022) warnings like Escaped LaTeX specials: \& started to appear in Rd files containing such escaped characters in the documentation files. It is sufficient to remove the offending backslashes if they are directly in the Rd or roxygen2 documentation.

These escapes are however correct syntax in bib files. Removing the backslashes from the bib file works but it is annoying and renders such bib entries incorrect for use in LaTeX.

Rdpack v2.3.1.9000 uploaded here today contains a fix which removes superfluous \ (backslashes), if present.

Please test and report comments any problems. It is entirely possible that there are undesired side effects, such as removing backslashes when they are really needed. In such cases, if possible, please include an example with a complete bibentry along with explanation of what went wrong.

GeoBosh commented 2 years ago

The simplest way to test is to run remotes::install_github("GeoBosh/Rdpack"), then build and check your package. You can also create the pdf manual and check if there are things like \&.

If you have R-devel installed and it previously complained about \& or similar, install Rdpack in R-devel from github and check your package with R-devel. You should no longer get the warning. Hopefully, you will not encounter new problems too.

GeoBosh commented 2 years ago

Rdpack v2.4 on CRAN fixes this.