inbo / checklist

An R package for checking R packages and R code
https://inbo.github.io/checklist
GNU General Public License v3.0
16 stars 2 forks source link

Spelling check marks unwanted items from roxygen documentation #102

Closed ElsLommelen closed 1 year ago

ElsLommelen commented 1 year ago

After running checklist::check_spelling() locally in a package that is written in dutch language, some words typical for roxygen documentation are (in my opinion incorrectly) marked as spelling mistakes:

Is there a way to mute this, other than adding these items as words to the .dic file?

ThierryO commented 1 year ago

The internal function spelling_parse_r() should strip @return and \eqn().

I prefer to use markdown syntax over latex syntax in Roxygen comments. It makes the documentation source easier to read.

ElsLommelen commented 1 year ago

Note for others with a similar issue: \eqn() is only stripped when the whole equation is set on one line.