Skip to content

Commit 9cac1d0

Browse files
authored
Polish docs (#2659)
* Use sentence case for titles * Don't use trailing `.`
1 parent 65ca8a3 commit 9cac1d0

17 files changed

Lines changed: 23 additions & 20 deletions

R/bash.R

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
1-
#' Open bash shell in package directory.
1+
#' Open bash shell in package directory
22
#'
33
#' @template devtools
44
#' @export

R/check-devtools.R

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
1-
#' Custom devtools release checks.
1+
#' Custom devtools release checks
22
#'
33
#' This function performs additional checks prior to release. It is called
44
#' automatically by [release()].

R/check-doc.R

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
1-
#' Check documentation, as `R CMD check` does.
1+
#' Check documentation, as `R CMD check` does
22
#'
33
#' This function attempts to run the documentation related checks in the
44
#' same way that `R CMD check` does. Unfortunately it can't run them

R/check-git.R

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
1-
#' Git checks.
1+
#' Git checks
22
#'
33
#' This function performs Git checks checks prior to release. It is called
44
#' automatically by [release()].

R/document.R

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
1-
#' Use roxygen to document a package.
1+
#' Use roxygen to document a package
22
#'
33
#' This function is a wrapper for the [roxygen2::roxygenize()]
44
#' function from the roxygen2 package. See the documentation and vignettes of

R/install.R

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
1-
#' Install a local development package.
1+
#' Install a local development package
22
#'
33
#' Uses `R CMD INSTALL` to install the package. Will also try to install
44
#' dependencies of the package from CRAN, if they're not already installed.
@@ -148,7 +148,7 @@ install <-
148148
invisible(TRUE)
149149
}
150150

151-
#' Install package dependencies if needed.
151+
#' Install package dependencies if needed
152152
#'
153153
#' `install_deps()` will install the
154154
#' user dependencies needed to run the package, `install_dev_deps()` will also

R/missing-s3.R

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
1-
#' Find missing s3 exports.
1+
#' Find missing s3 exports
22
#'
33
#' The method is heuristic - looking for objs with a period in their name.
44
#'

R/package.R

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
1-
#' Coerce input to a package.
1+
#' Coerce input to a package
22
#'
33
#' Possible specifications of package:
44
#' \itemize{
@@ -21,7 +21,7 @@ as.package <- function(x = NULL, create = deprecated()) {
2121
load_pkg_description(x)
2222
}
2323

24-
#' Find file in a package.
24+
#' Find file in a package
2525
#'
2626
#' It always starts by walking up the path until it finds the root directory,
2727
#' i.e. a directory containing `DESCRIPTION`. If it cannot find the root

R/release.R

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
1-
#' Release package to CRAN.
1+
#' Release package to CRAN
22
#'
33
#' @description
44
#' `r lifecycle::badge("deprecated")`

R/reload.R

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
1-
#' Unload and reload package.
1+
#' Unload and reload package
22
#'
33
#' This attempts to unload and reload an _installed_ package. If the package is
44
#' not loaded already, it does nothing. It's not always possible to cleanly

0 commit comments

Comments
 (0)