hadley/devtools — Issue #67: Patch: some docs for test()
Author: kenahoo
Created: 2012-02-28 23:07:51+00:00
State: open

I was confused about where tests for `test()` needed to live, and I also didn't know their proper naming convention. I've added a small doc paragraph for these facts.

From 8d9acc054731a885c3f5a320bcb11c3943bb7443 Mon Sep 17 00:00:00 2001
From: Ken Williams
Date: Tue, 28 Feb 2012 17:03:48 -0600
Subject: [PATCH] Add description of where the tests must be located

---
R/test.r | 6 +++++-
1 files changed, 5 insertions(+), 1 deletions(-)

diff --git a/R/test.r b/R/test.r
index 82fa4dd..eee8dd7 100644
--- a/R/test.r
+++ b/R/test.r
@@ -1,4 +1,8 @@
-#' Execute all test_that tests in a package
+#' Execute all \code{test_that} tests in a package.
+#'
+#' Tests are assumed to be located in a \code{inst/tests/} directory.
+#' See \code{\link{test_dir}} for the naming convention of test
+#' scripts within that directory.
#'
#' @param pkg package description, can be path or package name. See
#' \code{\link{as.package}} for more information
--
1.7.5.1