Act on feedback from @maelle

r-lib · Aug 14, 2018 · c33e338 · c33e338 · maelle · Aug 14, 2018
1 parent 00c111e
commit c33e338
Show file tree

Hide file tree

Showing 14 changed files with 35 additions and 32 deletions.
diff --git a/R/package.R b/R/package.R
@@ -1,9 +1,9 @@
 #' Depend on another package
 #'
 #' `use_package()` adds a CRAN package dependency to DESCRIPTION and offers a
-#' little advice about how to best use it. `use_dev_package()` adds a dependency
-#' on an in-development GitHub package, adding the repo to `Remotes` so it will
-#' be automatically installed from the correct location.
+#' little advice about how to best use it. `use_dev_package()` adds a versioned
+#' dependency on an in-development GitHub package, adding the repo to `Remotes`
+#' so it will be automatically installed from the correct location.
 #'
 #' @param package Name of package to depend on.
 #' @param type Type of dependency: must be one of "Imports", "Depends",
@@ -17,6 +17,7 @@
 #' \dontrun{
 #' use_package("ggplot2")
 #' use_package("dplyr", "suggests")
+#' use_dev_package("glue")
 #' }
 use_package <- function(package, type = "Imports") {
   types <- tolower(c("Imports", "Depends", "Suggests", "Enhances", "LinkingTo"))

diff --git a/R/pkgdown.R b/R/pkgdown.R
@@ -2,7 +2,7 @@
 #'
 #' [pkgdown](https://github.com/hadley/pkgdown) makes it easy to turn your
 #' package into a beautiful website. This helper creates `_pkgdown.yml`
-#' and `docs/` for you, and adds to `.Rbuildignore`
+#' and `docs/` for you, and adds them to `.Rbuildignore`
 #'
 #' @export
 use_pkgdown <- function() {

diff --git a/R/r.R b/R/r.R
@@ -1,4 +1,4 @@
-#' Create a new R file
+#' Create or edit a .R file
 #'
 #' @param name File name, without extension; will create if it doesn't already
 #'   exist. If not specified, and you're currently in a test file, will guess

diff --git a/R/tidyverse.R b/R/tidyverse.R
@@ -1,4 +1,4 @@
-#' Helpers for the tidyverse
+#' Helpers for tidyverse development
 #'
 #' These helpers follow tidyverse conventions which are generally a little
 #' stricter than the defaults, reflecting the need for greater rigor in

diff --git a/docs/index.html b/docs/index.html
diff --git a/docs/reference/index.html b/docs/reference/index.html
diff --git a/docs/reference/tidyverse.html b/docs/reference/tidyverse.html
diff --git a/docs/reference/use_package.html b/docs/reference/use_package.html
diff --git a/docs/reference/use_pkgdown.html b/docs/reference/use_pkgdown.html
diff --git a/docs/reference/use_r.html b/docs/reference/use_r.html
diff --git a/man/tidyverse.Rd b/man/tidyverse.Rd
diff --git a/man/use_package.Rd b/man/use_package.Rd
diff --git a/man/use_pkgdown.Rd b/man/use_pkgdown.Rd
diff --git a/man/use_r.Rd b/man/use_r.Rd