Как правильно документировать несуществующую функцию?

Что я прочитал

Я прочитал этот ТАК вопрос и связанные с ним ответы, но все еще немного растерялся, как документировать defunct функционировать должным образом в моем пакете.

Что я пробовал

  • Я заменил код моего defunctфункция по вызову .Defunct("<pointer to a function to be used instead>", "<my package name>")
  • Я удалил .Rd файл, содержащий старую документацию моей функции
  • Я создал mypackage-defunct.Rd файл с псевдонимом, указывающим на мой сейчас defunct имя функции
  • В mypackage-defunct.Rd Я создал \usage запись для моей старой функции и заменил аргументы функции на \dots (поскольку я не вижу необходимости отслеживать старые аргументы. Я немного следовал тому, что делается в base-defunct)

Что у меня есть

При беге RCMD CHECK Я получаю следующее WARNING:

проверка Rd \ использование разделов... ПРЕДУПРЕЖДЕНИЕ Недокументированные аргументы в объекте документации 'mypackage-defunct' '...'

Функции с записями \using должны иметь соответствующие записи \alias и документировать все их аргументы. Записи \use должны соответствовать синтаксически действительному R-коду. См. Главу "Написание файлов документации R" в руководстве "Написание R-расширений".

Что бы я хотел иметь

Как мне избавиться от предупреждения? Нужно ли документировать аргументы defunct функции? Дополнительный вопрос: каков рекомендуемый способ для несуществующей функции. Должен ли я удалить все аргументы и заменить их на ...? Смотря на base-defunctЯ вижу сочетание функций с правильными именами аргументов, . а также ...аргументы и пустые списки аргументов. Каков "правильный" способ?

0 ответов

Другие вопросы по тегам