Skip to content

Commit c773ad2

Browse files
authored
Merge pull request #60 from r-lib/f-42-doc-criteria
Add link to ?criteria and ?root_criterion
2 parents 45253f7 + 6a74102 commit c773ad2

File tree

3 files changed

+16
-13
lines changed

3 files changed

+16
-13
lines changed

R/file.R

Lines changed: 6 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -8,13 +8,14 @@
88
#' appends an arbitrary number of path components to the root using
99
#' [base::file.path()].
1010
#'
11-
#' @param criterion A criterion, will be coerced using
12-
#' [as_root_criterion()]
13-
#' @param path The start directory
14-
#' @param ... Further path components passed to [file.path()]
11+
#' @param criterion A criterion, one of the predefined [criteria]
12+
#' or created by [root_criterion()].
13+
#' Will be coerced using [as_root_criterion()].
14+
#' @param path The start directory.
15+
#' @param ... Further path components passed to [file.path()].
1516
#' @return The normalized path of the root as specified by the search criteria,
1617
#' with the additional path components appended.
17-
#' Throws an error if no root is found
18+
#' Throws an error if no root is found.
1819
#'
1920
#' @examples
2021
#' \dontrun{

man/find_root.Rd

Lines changed: 4 additions & 3 deletions
Some generated files are not rendered by default. Learn more about customizing how changed files appear on GitHub.

man/find_root_file.Rd

Lines changed: 6 additions & 5 deletions
Some generated files are not rendered by default. Learn more about customizing how changed files appear on GitHub.

0 commit comments

Comments
 (0)