docs: update polars_info's docs to link to related docs

R/expr__string.R

@@ -269,7 +269,7 @@ ExprStr_to_lowercase = function() {
 #' This method is only available with the feature flag "simd" which can
 #' be set via envvar "RPOLARS_FULL_FEATURES" and it requires
 #' Rust nightly toolchain to compile.
-#' See [`pl$polars_info()`][polars_info] for more details.
+#' See [`pl$polars_info()`][pl_polars_info] for more details.
 #' @examplesIf pl$polars_info()$features$simd
 #' pl$lit(c("hello there", "HI, THERE", NA))$str$to_titlecase()$to_series()
 ExprStr_to_titlecase = function() {

R/info.R

@@ -1,10 +1,12 @@
 #' Report information of the package
 #'
+#' This function reports the following information:
+#' - Package versions (the R package version and the dependent Rust Polars version)
+#' - [Number of threads used by Polars][pl_threadpool_size]
+#' - Rust feature flags (See `vignette("install", "polars")` for details)
 #' @return A list with information of the package
-#' @name polars_info
 #' @examples
 #' pl$polars_info()
-# TODO: Link to the installation vignette
 pl_polars_info = function() {
   # Similar to arrow::arrow_info()
   out = list(
@@ -78,7 +80,6 @@ check_feature = function(feature_name, context = NULL, call = sys.call(1L)) {
 #' It is strongly recommended not to override this value as it will be
 #' set automatically by the engine.
 #'
-#' @name threadpool_size
 #' @return The number of threads
 #' @examples
 #' pl$threadpool_size()

R/sql.R

@@ -1,7 +1,7 @@
 #' @title Run SQL queries against DataFrame/LazyFrame data.
 #' @description Run SQL queries against DataFrame/LazyFrame data.
 #' @details Currently, only available when built with the `full` feature.
-#' See [polars_info()] for more information.
+#' See [`pl$polars_info()`][pl_polars_info] for more information.
 #' @name SQLContext_class
 #' @keywords SQLContext
 #' @examplesIf pl$polars_info()$features$sql