No need to accept these changes. Opening the PR primarily as a feature showcase to get your impressions on the new roxylint features (currently only in the 7-sentence-case branch). It's much more precise, but quite a bit slower. Roxygenizing takes ~8s now, which is just enough to feel inconvenient.
Some of the updates are pretty self explanatory - things like adding a period for some @params or @returns, making @seealso a proper sentence as recommended in the tidyverse guide, or wrapping "R" in code fences.
Less obvious fixes:
CITATIONS.cff is used to populate an allow-list of author proper nouns
@concepts are added per roxygen block
Many acronyms are wrapped in \acronym{}, which I just learned is an acceptable texinfo tag
The \nolint{} tag was added, but I think that would force packages to take a hard dependency on roxylint for users to render docs.
undecided features:
colons are treated like full stops, expecting that what follows is the start of a new sentence
Debating \nolint{} and `r # nolint`. Neither one feels great - nolint due to portability and the inline code for how broadly it disables lints.
roxygen2::roxygenize() results:
And with those changes, we're down to a single lint:
ℹ [extract.R:15] @param should be 'Sentence case'.
Found improperly cased word(s): 'Sinharay', 'Sinharay', 'Templin', 'Bradshaw'
Which could be corrected with a citation, concept or \nolint{}
No need to accept these changes. Opening the PR primarily as a feature showcase to get your impressions on the new
roxylintfeatures (currently only in the7-sentence-casebranch). It's much more precise, but quite a bit slower. Roxygenizing takes ~8s now, which is just enough to feel inconvenient.Some of the updates are pretty self explanatory - things like adding a period for some
@params or@returns, making@seealsoa proper sentence as recommended in the tidyverse guide, or wrapping "R" in code fences.Less obvious fixes:
CITATIONS.cffis used to populate an allow-list of author proper nouns@conceptsare added per roxygen block\acronym{}, which I just learned is an acceptabletexinfotag\nolint{}tag was added, but I think that would force packages to take a hard dependency onroxylintfor users to render docs.undecided features:
\nolint{}and`r # nolint`. Neither one feels great -nolintdue to portability and the inline code for how broadly it disables lints.roxygen2::roxygenize()results:And with those changes, we're down to a single lint:
Which could be corrected with a citation, concept or
\nolint{}