Skip to content
Browse files

Documentation fixes

  • Loading branch information...
1 parent ba105b0 commit efe233568fcca145d9f1a32512c3a5b5e17fb41e @hadley committed
Showing with 29 additions and 15 deletions.
  1. +7 −2 R/check-cran.r
  2. +1 −1 R/document.r
  3. +4 −4 R/install.r
  4. +12 −2 man/check_cran.Rd
  5. +1 −1 man/show_rd.Rd
  6. +4 −5 man/with_debug.Rd
View
9 R/check-cran.r
@@ -11,11 +11,16 @@
#' session-specific temporary directory, so all files will be removed
#' when your current R session ends.
#'
-#' @param pkg Package name - note that unlike other \pkg{devtools} functions
-#' this is the name of a CRAN package, not a path.
+#' @param pkgs Vector of package names - note that unlike other \pkg{devtools}
+#' functions this is the name of a CRAN package, not a path.
#' @param libpath path to library to store dependencies packages - if you
#' you're doing this a lot it's a good idea to pick a directory and stick
#' with it so you don't have to download all the packages every time.
+#' @param srcpath path to directory to store source versions of dependent
+#' packages - again, this saves a lot of time because you don't need to
+#' redownload the packages every time you run the package.
+#' @param bioconductor include bioconductor packages in checking?
+#' @param type binary package type of test
#' @return invisible \code{TRUE} if successful and no ERRORs or WARNINGS,
#' @param ... other parameters passed onto \code{\link{download.packages}}
#' @importFrom tools package_dependencies
View
2 R/document.r
@@ -56,7 +56,7 @@ check_doc <- function(pkg = NULL) {
#' @param pkg package description, can be path or package name. See
#' \code{\link{as.package}} for more information
#' @param file name of Rd file to open. Can optionally omit Rd extension.
-#' @param ... additional arguments passed onto \code{\link[utils]{Rd2txt}}.
+#' @param ... additional arguments passed onto \code{\link[tools]{Rd2txt}}.
#' This is particular useful if you're checking macros and want to simulate
#' what happens when the package is built (\code{stage = "build"})
#' @export
View
8 R/install.r
@@ -61,10 +61,10 @@ install_deps <- function(pkg = NULL) {
#' Temporarily set debugging compilation flags.
#'
#' @param code to execute.
-#' @param \env{PKG_CFLAGS} flags for compiling C code
-#' @param \env{PKG_CXXFLAGS} flags for compiling C++ code
-#' @param \env{PKG_FFLAGS} flags for compiling Fortran code.
-#' @param \env{PKG_FCFLAGS} flags for Fortran 9x code.
+#' @param PKG_CFLAGS flags for compiling C code
+#' @param PKG_CXXFLAGS flags for compiling C++ code
+#' @param PKG_FFLAGS flags for compiling Fortran code.
+#' @param PKG_FCFLAGS flags for Fortran 9x code.
#' @export
#' @examples
#' \dontrun{
View
14 man/check_cran.Rd
@@ -7,8 +7,8 @@
type = getOption("pkgType"), ...)
}
\arguments{
- \item{pkg}{Package name - note that unlike other
- \pkg{devtools} functions this is the name of a CRAN
+ \item{pkgs}{Vector of package names - note that unlike
+ other \pkg{devtools} functions this is the name of a CRAN
package, not a path.}
\item{libpath}{path to library to store dependencies
@@ -16,6 +16,16 @@
idea to pick a directory and stick with it so you don't
have to download all the packages every time.}
+ \item{srcpath}{path to directory to store source versions
+ of dependent packages - again, this saves a lot of time
+ because you don't need to redownload the packages every
+ time you run the package.}
+
+ \item{bioconductor}{include bioconductor packages in
+ checking?}
+
+ \item{type}{binary package type of test}
+
\item{...}{other parameters passed onto
\code{\link{download.packages}}}
}
View
2 man/show_rd.Rd
@@ -12,7 +12,7 @@
Rd extension.}
\item{...}{additional arguments passed onto
- \code{\link[utils]{Rd2txt}}. This is particular useful
+ \code{\link[tools]{Rd2txt}}. This is particular useful
if you're checking macros and want to simulate what
happens when the package is built (\code{stage =
"build"})}
View
9 man/with_debug.Rd
@@ -10,14 +10,13 @@
\arguments{
\item{code}{to execute.}
- \item{\env{PKG_CFLAGS}}{flags for compiling C code}
+ \item{PKG_CFLAGS}{flags for compiling C code}
- \item{\env{PKG_CXXFLAGS}}{flags for compiling C++ code}
+ \item{PKG_CXXFLAGS}{flags for compiling C++ code}
- \item{\env{PKG_FFLAGS}}{flags for compiling Fortran
- code.}
+ \item{PKG_FFLAGS}{flags for compiling Fortran code.}
- \item{\env{PKG_FCFLAGS}}{flags for Fortran 9x code.}
+ \item{PKG_FCFLAGS}{flags for Fortran 9x code.}
}
\description{
Temporarily set debugging compilation flags.

0 comments on commit efe2335

Please sign in to comment.
Something went wrong with that request. Please try again.