Skip to content

Commit 6a93692

Browse files
committed
Clarify docs.
1 parent 7df319f commit 6a93692

File tree

2 files changed

+19
-19
lines changed

2 files changed

+19
-19
lines changed

R/funs.R

Lines changed: 9 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -1,16 +1,16 @@
11
#' Get hex sticker from web
22
#'
3-
#' This function *tries* to search for the sticker for the package you want. If
4-
#' the package is one with a sticker in the
5-
#' [rstudio/hex-stickers](https://github.com/rstudio/hex-stickers) repository,
6-
#' it will come from there. If you want SVG rather than PNG, specify a filename.
3+
#' This function *tries* to search for the sticker for the package you want.
74
#'
8-
#' If not, this function attempts to get the package's GitHub repository from the
9-
#' package description, and look for the sticker in the man/figures directory.
5+
#' It will automatically get stickers for any packages in the
6+
#' [rstudio/hex-stickers](https://github.com/rstudio/hex-stickers) repository
7+
#' or if the package's GitHub repository is specified in the DESCRIPTION and
8+
#' the `man/figures` directory contains (1) exactly one file
9+
#' or (2) a file named `logo.png`. These cases cover *most* CRAN packages.
1010
#'
11-
#' In case this function cannot find the sticker, escape hatches are provided
12-
#' for specifying the repository, path within the repository, and filename of the sticker
13-
#' you want.
11+
#' For packages where the sticker cannot be automatically found or defaults must
12+
#' be overridden, the `repository`, `path`, and `filename` arguments provide
13+
#' escape hatches.
1414
#'
1515
#' Packages stored somewhere other than GitHub are currently unsupported.
1616
#'

man/stickr_get.Rd

Lines changed: 10 additions & 10 deletions
Some generated files are not rendered by default. Learn more about customizing how changed files appear on GitHub.

0 commit comments

Comments
 (0)