Skip to content

Commit f2636ec

Browse files
Updated configure doc
1 parent 68d1d6b commit f2636ec

File tree

2 files changed

+34
-30
lines changed

2 files changed

+34
-30
lines changed

R/config.R

Lines changed: 16 additions & 12 deletions
Original file line numberDiff line numberDiff line change
@@ -10,18 +10,22 @@ option_env$unknown_locations <- FALSE
1010
#' Configures various options for this package. If no value is given for any
1111
#' option, it's default is used.
1212
#'
13-
#' @param flowr_host The host where the flowr server is running. Defaults to
14-
#' "localhost".
15-
#' @param flowr_port The port where the flowr server is running. Defaults to
16-
#' 1042.
17-
#' @param measure_time Whether to measure the execution time of different
18-
#' calculations. Defaults to FALSE.
19-
#' @param return_covr_result Whether to also return the coverage covr calculated
20-
#' @param slicing_points Whether to return all slicing points we found and slices for
21-
#' @param log_level The minimum level of logs that should be shown
22-
#' @param unknown_locations Whether to return the number of source refs flowr did not
23-
#' know about
24-
#' @param list A list of options to set.
13+
#' @param list Options passed explicitly as a list
14+
#' @param ... Key value pairs of options. The following options are available:
15+
#' \itemize{
16+
#' \item flowr_host The host where the flowr server is running. Defaults to
17+
#' "localhost".
18+
#' \item flowr_port The port where the flowr server is running. Defaults to
19+
#' 1042.
20+
#' \item measure_time Whether to measure the execution time of different
21+
#' calculations. Defaults to FALSE.
22+
#' \item return_covr_result Whether to also return the coverage covr calculated
23+
#' \item slicing_points Whether to return all slicing points we found and slices for
24+
#' \item log_level The minimum level of logs that should be shown
25+
#' \item unknown_locations Whether to return the number of source refs flowr did not
26+
#' know about
27+
#' }
28+
#' @return A list of all options and their values before the configuration.
2529
#'
2630
#' @export
2731
configure <- function(list = NULL, ...) {

man/configure.Rd

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

0 commit comments

Comments
 (0)