-
Notifications
You must be signed in to change notification settings - Fork 0
Open
Description
We have CHECKs complaining about using e.g. {epiprocess}
[in roxygen comments; this seems to matter for downlit behavior for our alternatives, though the CHECK complaint is about the .Rd, not related to downlit]. Three approaches:
- Use
`{epiprocess}`
--- roxygen2's to\code{{epiprocess}}
, which doesn't trigger CHECK.- In both normal help and downlit: no linking.
- Use
\code{\link[epiprocess:epiprocess]{\{epiprocess\}}}
- In both normal help and downlit: links to
?epiprocess::epiprocess
in a matching medium (normal help display or pkgdown site)... seems like a good approach but?epiprocess::epiprocess
seems very outdated right now.
- In both normal help and downlit: links to
- Use
[`{epiprocess}`](https://cmu-delphi.github.io/epiprocess/reference/epiprocess.html)
or, equivalently,`r paste0("[\u0060{epiprocess}\u0060](", downlit::autolink_url("epiprocess::epiprocess"), ")")`
- In both normal help and downlit: links to package landing page URL. Note this might feel a little weird for the normal help file.
Second approach should probably only happen after the epiprocess package-level documentation topic has been updated.