Skip to content

Commit

Permalink
document multi-component args, closes #7
Browse files Browse the repository at this point in the history
- More explicit documentation for the `...` argument to `here()` (#7).
  • Loading branch information
krlmlr committed Dec 14, 2017
1 parent 93593ee commit 60c863f
Show file tree
Hide file tree
Showing 2 changed files with 13 additions and 3 deletions.
7 changes: 6 additions & 1 deletion R/here.R
Expand Up @@ -14,10 +14,15 @@
#'
#' @param ... `[character]`\cr
#' Path components below the project root, can be empty.
#' Each argument should be a string containing one or more
#' path components separated by a forward slash `"/"`.
#' @export
#' @examples
#' here()
#' \dontrun{here("some/path/below/your/project/root.txt")}
#' \dontrun{
#' here("some", "path", "below", "your", "project", "root.txt")
#' here("some/path/below/your/project/root.txt")
#' }
here <- function(...) {
.root_env$f(...)
}
Expand Down
9 changes: 7 additions & 2 deletions man/here.Rd

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

0 comments on commit 60c863f

Please sign in to comment.