Нефайловые ссылки, привязанные к пакету, в объекте документации - PullRequest
Новая
       35

Нефайловые ссылки, привязанные к пакету, в объекте документации

9 голосов
/ 17 июня 2020

При проверке пакета R я получил несколько предупреждений о ссылках на документацию. 

* checking Rd cross-references ... WARNING
Non-file package-anchored link(s) in documentation object 'show_sig_consensusmap.Rd':
  ‘[NMF:consensusmap]{NMF::consensusmap}’

Non-file package-anchored link(s) in documentation object 'show_sig_number_survey2.Rd':
  ‘[NMF]{summary}’

Странно, что такие предупреждения появляются только в ОС Debian. 

package sigminer_1.0.7.tar.gz does not pass the incoming checks automatically, please see the following pre-tests:
Windows: <https://win-builder.r-project.org/incoming_pretest/sigminer_1.0.7_20200616_163758/Windows/00check.log>
Status: OK
Debian: <https://win-builder.r-project.org/incoming_pretest/sigminer_1.0.7_20200616_163758/Debian/00check.log>
Status: 1 WARNING

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

enter image description here

Есть ли лучшее решение?

1 Ответ

9 голосов
/ 17 июня 2020

Кажется, что если вы используете ссылки в форме \code{\link[pkg]{foo}}, указывающие на страницы справки, содержащие несколько функций, ссылка должна указывать только на основную функцию.

Например, скажем, функции foo_1 и foo_2 описаны на той же странице справки, а foo_1 - основная функция (т. е. отображается в верхнем левом углу страницы справки).

Чтобы создать ссылку на foo_2, вы должны использовать \code{\link[pkg:foo_1]{foo_2}}.

См. этот выпуск GH и эту ссылку в письменной форме R расширения.

...