Skip to content

Commit 179cfae

Browse files
authored
docs: mention limitation of some autolinking features to inline code
1 parent 2ee8018 commit 179cfae

1 file changed

Lines changed: 5 additions & 5 deletions

File tree

vignettes/linking.Rmd

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -23,18 +23,18 @@ knitr::opts_chunk$set(
2323
pkgdown will automatically link to documentation and articles wherever it's possible to do unambiguously. This includes:
2424

2525
* Bare function calls, like `build_site()`.
26-
* Calls to `?`, like `?build_site` or `package?pkgdown`.
27-
* Calls to `help()`, like `help("pkgdown")`.
28-
* Calls to `vignette()`, like `vignette("pkgdown")`.
26+
* Calls to `?`, like `?build_site` or `package?pkgdown` (in inline code).
27+
* Calls to `help()`, like `help("pkgdown")` (in inline code).
28+
* Calls to `vignette()`, like `vignette("pkgdown")` (in inline code).
2929

3030
## Across packages
3131

3232
Linking to documentation in another package is straightforward. Just adapt the call in the usual way:
3333

3434
* `purrr::map()`, `MASS::addterm()`.
3535
* `?purrr::map`, `?MASS::addterm`.
36-
* `vignette("other-langs", package = "purrr")`, `vignette("longintro", package = "rpart")`
37-
* `{purrr}`
36+
* `vignette("other-langs", package = "purrr")`, `vignette("longintro", package = "rpart")` (in inline code)
37+
* `{purrr}` (in inline code)
3838

3939
If pkgdown can find a pkgdown site for the remote package, it will link to it; otherwise, it will link to <https://rdrr.io/> for documentation and CRAN for vignettes. In order for a pkgdown site to be findable, it needs to be listed in two places:
4040

0 commit comments

Comments
 (0)