Skip to content

Commit

Permalink
Fix typos + add cross-references
Browse files Browse the repository at this point in the history
  • Loading branch information
olivroy committed Jun 4, 2024
1 parent f3cf62b commit 8f3a286
Show file tree
Hide file tree
Showing 8 changed files with 19 additions and 21 deletions.
3 changes: 1 addition & 2 deletions R/build-articles.R
Original file line number Diff line number Diff line change
Expand Up @@ -174,8 +174,7 @@
#'
#' # Suppressing vignettes
#' If you want [articles](https://r-pkgs.org/vignettes.html#sec-vignettes-article)
#' that are not vignettes, use `usethis::use_article()` either put them in
#' subdirectories or list in `.Rbuildignore`. An articles link will be
#' that are not vignettes, use `usethis::use_article()` to create it. An articles link will be
#' automatically added to the default navbar if the vignettes directory is
#' present: if you do not want this, you will need to customise the navbar. See
#' [build_site()] details.
Expand Down
10 changes: 5 additions & 5 deletions R/build-favicons.R
Original file line number Diff line number Diff line change
@@ -1,16 +1,16 @@
#' Create favicons from package logo
#' Initialise favicons from package logo
#'
#' This function auto-detects the location of your package logo (with the name
#' `logo.svg` (recommended format) or `logo.png`) and runs it through the
#' <https://realfavicongenerator.net> API to build a complete set of favicons
#' with different sizes, as needed for modern web usage.
#' `logo.svg` (recommended format) or `logo.png`, created with `usethis::use_logo()`)
#' and runs it through the <https://realfavicongenerator.net> API to build a
#' complete set of favicons with different sizes, as needed for modern web usage.
#'
#' You only need to run the function once. The favicon set will be stored in
#' `pkgdown/favicon` and copied by [init_site()] to the relevant location when
#' the website is rebuilt.
#'
#' Once complete, you should add `pkgdown/` to `.Rbuildignore ` to avoid a NOTE
#' during package checking.
#' during package checking. (`usethis::use_logo()` does this for you!)
#'
#' @inheritParams as_pkgdown
#' @param overwrite If `TRUE`, re-create favicons from package logo.
Expand Down
2 changes: 1 addition & 1 deletion R/build-reference.R
Original file line number Diff line number Diff line change
Expand Up @@ -83,7 +83,7 @@
#' * `has_lifecycle("deprecated")` will select all topics with lifecycle
#' deprecated.
#'
#' All functions (except for `has_keywords()`) automatically exclude internal
#' All functions (except for `has_keyword()`) automatically exclude internal
#' topics (i.e. those with `\keyword{internal}`). You can choose to include
#' with (e.g.) `starts_with("build_", internal = TRUE)`.
#'
Expand Down
3 changes: 1 addition & 2 deletions man/build_articles.Rd

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

10 changes: 5 additions & 5 deletions man/build_favicons.Rd

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

2 changes: 1 addition & 1 deletion man/build_reference.Rd

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

8 changes: 4 additions & 4 deletions pkgdown/_pkgdown.yml
Original file line number Diff line number Diff line change
Expand Up @@ -63,10 +63,9 @@ reference:
desc: These functions are useful for rapid iteration when you're working on a
specific part of your site.
contents:
- starts_with("build_")
- -build_site
- -build_site_github_pages
- -build_favicons
- has_concept("site components")
- build_search
- build_redirects
- init_site

- subtitle: Customisation
Expand Down Expand Up @@ -98,6 +97,7 @@ reference:

redirects:
- ["articles/search.html", "reference/build_search.html"]
- ["articles/pkgdown.html#language", "articles/translations.html"]

news:
releases:
Expand Down
2 changes: 1 addition & 1 deletion vignettes/translations.Rmd
Original file line number Diff line number Diff line change
Expand Up @@ -92,5 +92,5 @@ Then commit your changes to Git and submit your pull request for review:

```{r}
#| eval: false
usethis::pr_submit()
usethis::pr_push()
```

0 comments on commit 8f3a286

Please sign in to comment.