From cf81948d549b314debad3421849428bb8df1526d Mon Sep 17 00:00:00 2001
From: Romain Francois <romain@purrple.cat>
Date: Sat, 9 Mar 2024 18:59:37 +0100
Subject: [PATCH] add value to auto() doc

---
 R/auto.R    |  2 ++
 man/auto.Rd | 19 +++++++++++--------
 2 files changed, 13 insertions(+), 8 deletions(-)

diff --git a/R/auto.R b/R/auto.R
index e9d1869..86db931 100644
--- a/R/auto.R
+++ b/R/auto.R
@@ -13,6 +13,8 @@ rx_call <- glue::glue("({rx_valid_pkg})::({rx_valid_fun})\\(\\)")
 #' @param call Function call of the form `pkg::fun()`
 #' @param ... See [bslib::tooltip()]
 #'
+#' @return [to_pkg()] and [to_call()] return text to include in html documents
+#'
 #' @examples
 #'
 #' \dontrun{
diff --git a/man/auto.Rd b/man/auto.Rd
index fafafec..61a998f 100644
--- a/man/auto.Rd
+++ b/man/auto.Rd
@@ -1,29 +1,32 @@
 % Generated by roxygen2: do not edit by hand
 % Please edit documentation in R/auto.R
-\name{to_pkg}
+\name{auto}
+\alias{auto}
 \alias{to_pkg}
 \alias{to_call}
-\alias{auto}
 \title{Setup automatic linking}
 \usage{
+auto(type = c("tooltip", "plain"), keep_braces = TRUE, keep_pkg_prefix = TRUE)
+
 to_pkg(pkg, type = c("tooltip", "plain"), keep_braces = TRUE, ...)
 
 to_call(call, type = c("tooltip", "plain"), keep_pkg_prefix = TRUE, ...)
-
-auto(type = c("tooltip", "plain"), keep_braces = TRUE, keep_pkg_prefix = TRUE)
 }
 \arguments{
-\item{pkg}{package name}
-
 \item{type}{"plain" for plain links, "tooltip" for adding a tooltip}
 
 \item{keep_braces}{Should the braces be kept ?}
 
+\item{keep_pkg_prefix}{Should the package prefix be kept ?}
+
+\item{pkg}{package name}
+
 \item{...}{See \code{\link[bslib:tooltip]{bslib::tooltip()}}}
 
 \item{call}{Function call of the form \code{pkg::fun()}}
-
-\item{keep_pkg_prefix}{Should the package prefix be kept ?}
+}
+\value{
+\code{\link[=to_pkg]{to_pkg()}} and \code{\link[=to_call]{to_call()}} return text to include in html documents
 }
 \description{
 Setup automatic linking