-
Notifications
You must be signed in to change notification settings - Fork 238
Closed
Labels
Description
This can be a problem because the resulting .Rd files will fail various automated linting processes, most notably BiocCheck::BiocCheck(), which checks for a <= 80 line length, including .Rd files.
I have created a repository that captures a minimal example of this: https://github.com/multimeric/RoxygenLineLength. This repository already has R source files and the resulting .Rd docs produced from them, but you can also regenerate the .Rd using roxygen2::roxygenise() if you clone the repository.
The two cases I can consistently identify that trigger this are:
- A title section with a line length very close to 80: https://github.com/multimeric/RoxygenLineLength/blob/835a32205c9c01c7b954e6680daff9daf8ec30af/R/doc.R#L8. This seems to happen because Roxygen2 formats
titleas:Instead of the following format that it uses for other fields, which is immune to excessive line lengths if the source documentation is also <80 chars:\title{content}\title{ content } - Basically any use of
inheritDotParams: https://github.com/multimeric/RoxygenLineLength/blob/835a32205c9c01c7b954e6680daff9daf8ec30af/R/doc.R#L10
Reactions are currently unavailable