#r #package #documentation #roxygen #lintr
Вопрос:
Я использую lintr пакет для проверки несоответствия стандартам кодирования tidyverse в моем пакете. Однако проблема, с которой я имею дело, заключается в том, что пакет lintr вызывает проблемы с превышением 80 символов в строке даже в документации roxygen, которую я не хочу, чтобы он проверял.
Так, например, пакет lintr будет по ошибке Lines should not be more than 80 characters для
#' @description This a description for very good function which does a lot of good things and it's not so long as this description .
Мой вопрос в том, как я могу игнорировать все пометки, в которых строки превышают 80 символов в документации (я хочу, чтобы у меня все еще были замечания по поводу длинных строк при работе с обычным кодом).
Ответ №1:
Я не думаю lintr , что у вас есть контроль на таком высоком уровне (хотя я полагаю, что вы могли бы отправить PR, чтобы сделать это). Но нет необходимости в таких длинных строках документа; ваше описание будет работать нормально, если вы отформатируете его в нескольких строках, например
#' @description
#' This a description for very good function which does a lot of good things
#' and it's not so long as this description.