search

OuhscBbmc / OuhscMunge

Data manipulation operations
http://ouhscbbmc.github.io/OuhscMunge/
Other
1 stars 4 forks source link

fix documentation links #109

Closed wibeasley closed 4 years ago

wibeasley commented 4 years ago

I'm getting a lot of build warnings like the one below. Judging from a SO question, and bcgov issue and commit, I need to distinguish between the name of the Rd file and the name of the function.

    clump_date                              html  
Rd warning: D:/Projects/Ouhsc/Bbmc/r-package/OuhscMunge/man/clump_date.Rd:58: 
file link 'wday' in package 'lubridate' does not exist and so has been treated as a topic
wibeasley commented 4 years ago

Note to future self about \code{\link[checkmate:checkClass]{checkmate::assert_class()}}:

  1. code uses {
  2. link uses [
  3. Rd comes first, the function second (ie, checkClass vs assert_class())
  4. The Rd uses :, while the function uses ::.

I fixed it so it's not giving any warnings. So if there are problems, they'll be less likely drowned out by these guys.

According to issue 707 in https://github.com/r-lib/roxygen2/issues, there are some good arguments why this effort was silly and more brittle. And should be fixed in R itself.