docs: improve documentation of prudence argument

Author: maelle

R/compute-rd.R

@@ -12,11 +12,12 @@
 #' @param name The name of the table to store the result in.
 #' @param schema_name The schema to store the result in, defaults to the current schema.
 #' @param temporary Set to `FALSE` to store the result in a permanent table.
-#' @param prudence Convenience argument to control automatic materialization of data.
+#' @param prudence Convenience argument to control automatic materialization of data,
+#' for memory protection.
 #'
-#'   - `"lavish"`: regardless of size,
-#'   - `"frugal"`: never,
-#'   - `"thrifty"`: up to a maximum size of 1 million cells.
+#'   - `"lavish"`: automatically materialize _regardless of size_,
+#'   - `"frugal"`: _never_ automatically materialize,
+#'   - `"thrifty"`: automatically materialize _up to a maximum size of 1 million cells_.
 #'
 #' The default is to inherit from the input.
 #' The same effect can be achieved by forwarding the output to [as_duckdb_tibble()]

R/ducktbl.R

@@ -11,11 +11,12 @@
 #'
 #' @param ... For `duckdb_tibble()`, passed on to [tibble()].
 #'   For `as_duckdb_tibble()`, passed on to methods.
-#' @param prudence,.prudence Controls automatic materialization of data.
+#' @param prudence,.prudence Controls automatic materialization of data,
+#' for memory protection.
 #'
-#'   - `"lavish"`: regardless of size,
-#'   - `"frugal"`: never,
-#'   - `"thrifty"`: up to a maximum size of 1 million cells.
+#'   - `"lavish"`: automatically materialize _regardless of size_,
+#'   - `"frugal"`: _never_ automatically materialize,
+#'   - `"thrifty"`: automatically materialize _up to a maximum size of 1 million cells_.
 #'
 #' The default is `"lavish"` for `duckdb_tibble()` and `as_duckdb_tibble()`,
 #' and may be different for other functions.

R/io2.R

@@ -90,11 +90,11 @@ read_json_duckdb <- function(path, ..., prudence = c("thrifty", "lavish", "fruga
 #' @param table_function The name of a table-valued
 #'   DuckDB function such as `"read_parquet"`,
 #'   `"read_csv"`, `"read_csv_auto"` or `"read_json"`.
-#' @param prudence Controls automatic materialization of data.
+#' @param prudence Controls automatic materialization of data, for memory protection.
 #'
-#'   - `"thrifty"`: up to a maximum size of 1 million cells,
-#'   - `"lavish"`: regardless of size,
-#'   - `"frugal"`: never.
+#'   - `"lavish"`: automatically materialize _regardless of size_,
+#'   - `"frugal"`: _never_ automatically materialize,
+#'   - `"thrifty"`: automatically materialize _up to a maximum size of 1 million cells_.
 #'
 #' The default is `"thrifty"` for the ingestion functions,
 #' and may be different for other functions.