docs: Tweak (#56)

Closes #56.

R/as_duckplyr_df.R

@@ -2,7 +2,10 @@
 #'
 #' For an object of class `duckplyr_df`,
 #' dplyr verbs such as [mutate()], [select()] or [filter()]  will attempt to use DuckDB.
-#' If this is not possible for whatever reason, the original dplyr implementation is used.
+#' If this is not possible, the original dplyr implementation is used.
+#'
+#' Set the `DUCKPLYR_FALLBACK_INFO` and `DUCKPLYR_FORCE` environment variables
+#' for more control over the behavior, see [config] for more details.
 #'
 #' @param .data data frame or tibble to transform
 #'

R/config.R

@@ -12,7 +12,7 @@
 #' @section Environment variables:
 #'
 #' `DUCKPLYR_OUTPUT_ORDER`: If `TRUE`, row output order is preserved.
-#' If `FALSE`,
+#' The default may change the row order where dplyr would keep it stable.
 #'
 #' `DUCKPLYR_FORCE`: If `TRUE`, fail if duckdb cannot handle a request.
 #'

R/csv.R

@@ -34,7 +34,12 @@
 #' df$a
 #'
 #' # Return as tibble:
-#' df_from_file(path, "read_csv_auto", class = class(tibble()))
+#' df_from_file(
+#'   path,
+#'   "read_csv",
+#'   options = list(delim = ",", auto_detect = TRUE),
+#'   class = class(tibble())
+#' )
 #'
 #' unlink(path)
 df_from_file <- function(path,

R/stats.R

@@ -3,7 +3,8 @@ stats <- new_environment(list(attempts = 0L, fallback = 0L, calls = character())
 #' Show stats
 #'
 #' Prints statistics on how many calls were handled by DuckDB.
-#'
+#' The output shows the total number of requests in the current session,
+#' split by fallbacks to dplyr and requests handled by duckdb.
 #'
 #' @return Called for its side effect.
 #'