improved doc

Author: s-fleck

R/test_skeleton.R

@@ -15,6 +15,7 @@
 #'   compatibility with testthat.
 #'
 #' @return `NULL` (invisibly)
+#' @seealso [usethis::use_test()]
 #'
 #' @export
 #'

R/test_subdir.R

@@ -1,4 +1,4 @@
-#' Use test subdirectories
+#' Run tests in subdirectories
 #'
 #' This is a simple wrapper for [devtools::test()], but rather than running
 #' the tests in \file{inst/tests/} or \file{tests/testthat}, it runs the tests

R/testthis-package.R

@@ -2,7 +2,7 @@
 #'
 #' RStudio addins for several common testing-related tasks during package
 #' development, such as switching between a source file and an associated test
-#' file, or running unit tests in a single test file (hotkeyable!).
+#' file, or running unit tests in a single test file (hotkeyable in RStudio!).
 #' testthis also provides utility function to manage tests in subdirectories of
 #' the test/testthis directory.
 #'
@@ -12,14 +12,29 @@
 #' @import assertthat
 #' @importFrom magrittr %>%
 #'
+#' @section Setting the project path:
+#'
+#' Testthis uses [usethis::proj_get()] to detect project root of the current
+#' working directory. You can override the project root with
+#' [usethis::proj_set()].
+#'
 #' @section Package options:
 #'
+#' Package options can be set with [`options()`]. You can add `options()` to
+#' your \file{.Rprofile} to make them permanent across sessions.
+#'
 #' \describe{
+#'
 #' \item{`testthis.sep`}{Default separator to use when creating test files with
 #'   `test_skeleton()`. Defaults to `_`, must be either `_` or `-`; i.e whether
 #'   you want your files to be named `test_foofunction.R` or `test-foofunction.R`}
-#' }
 #'
+#' \item{`testthis.integration_tests_path`, `testthis.acceptance_tests_path`,
+#' `testthis.manual_tests_path`}{Default paths used by the functions
+#'  `testthis::use_integration_tests()`, `testthis::test_integration()`, etc...}
+#'}
+#'
+#' @seealso [usethis::edit_r_profile()]
 #' @docType package
 "_PACKAGE"
 

README.Rmd

@@ -8,7 +8,8 @@ output: github_document
 
 ## Overview
 
-Testhis provides RStudio addins for common package development tasks:
+Testhis provides utility functions and RStudio addins for common package 
+development tasks:
 
 * `test_this()`: Run tests associated with the currently open R script file.
 * `lest_this()`: "Load and test"; As above, but call `devtools::load_all()` first

cran-comments.md

@@ -14,8 +14,9 @@ This is a new release, so there are no reverse dependencies.
 
 ## Notes
 
-Most functions in this package modify the file system or are designed to be
-run interactively. That is why most code examples in the documentation are
-wrapped in `\dontrun{}`.
+* Most functions in this package modify the file system or are designed to be
+  run interactively. That is why most code examples in the documentation are
+  wrapped in `\dontrun{}`.
+* Removed all `:::` calls from the original submission.
 
 ---

vignettes/testthis.Rmd

@@ -23,17 +23,18 @@ library(rstudioapi)
 
 ## Overview
 
-Testthis provides tools to make unit testing in R more comfortable. It is 
+Testthis contains tools to make unit testing in R more comfortable. It is 
 designed to complement the packages **testthat**, **devtools** and **usethis**. 
 
 
 
-
 ## RStudio addins 
 
-Provides RStudio addins for common tasks, that can also be assigned to hotkeys. 
-I recommend assigning `ctrl+alt+Insert`, `ctrl+alt+Pos1` and `ctrl+alt+PageUp`
-to the following functions (under *Tools/Modify Keyboard Shortcuts*):
+Testthis provides RStudio addins for common tasks. These can be called like
+normal R function, but it is also possible to assigned to hotkeys to them in
+RStudio (*Tools/Modify Keyboard Shortcuts*). I recommend assigning 
+`ctrl+alt+Insert`, `ctrl+alt+Pos1` and `ctrl+alt+PageUp` to the following 
+functions:
 
 * `test_this()`: Run tests associated with the currently open R script file.
 * `lest_this()`: "Load and test"; As above, but call `devtools::load_all()` first
@@ -46,15 +47,15 @@ to the following functions (under *Tools/Modify Keyboard Shortcuts*):
 The functions above assume that if the current filename is `currentfile.R`,
 the associated test file is `/tests/testthat/test_currentfile.R`. If you want
 to modify this behaviour you can put the tag `#* @testfile anotherfile` anywhere
-in your code, usually the top or bottom of your .R file. Each R script can only
+in your code, usually the top or bottom of your `.R` file. Each R script can only
 have a single associated testfile.
 
 The following example will associate the file `/tests/testthat/other_test_file.R`
 instead of `/tests/testthat/test_open_testfile.R` with `R/open_testfile`:
 ```{r eval = FALSE}
 # file R/open_testfile.R
-#* @testfile other_testfile
 
+#* @testfile other_testfile
 open_testfile <- function(){
   fname <- get_testfile_name()