Несоответствия документации по коду в пакете R - PullRequest
0 голосов
/ 08 апреля 2020

При написании и поддержке пакета R у нас есть процесс создания devtools::document, который обновляет NAMESPACE. Но есть ситуации, когда мы не выполняем обновление документа перед пу sh на github. поэтому мы пытаемся использовать некоторые проверки документации кода, доступные через tools::codoc или другие методы, чтобы попытаться зафиксировать такие изменения.

Я заметил, что функция tools::codoc в настоящее время только проверяет несоответствие между структурами функции. но есть ли процесс, чтобы выяснить различия между экспортируемыми объектами и неэкспортированными объектами, а также.

Например, давайте рассмотрим следующую функцию

#' @export
f1 <- function(i12){
  return(NULL)
}

публикация документации, файл man для функции создается и также добавляется в файл NAMESPACE. любые изменения в аргументах функции обнаруживаются при проверке несоответствия документации кода, но изменение, при котором функция больше не экспортируется, не отображается в проверке.

есть ли способ, чтобы это было захвачено?

Добро пожаловать на сайт PullRequest, где вы можете задавать вопросы и получать ответы от других членов сообщества.
...