From 22fa888dd45f88894ec5b22be12707a093172c71 Mon Sep 17 00:00:00 2001
From: atusy <30277794+atusy@users.noreply.github.com>
Date: Mon, 13 Mar 2023 23:32:33 +0900
Subject: [PATCH] docs: footnote_option allows function as a value of ref

---
 R/footnote.R | 10 +++++++---
 1 file changed, 7 insertions(+), 3 deletions(-)

diff --git a/R/footnote.R b/R/footnote.R
index e10b978..4c4a0bc 100644
--- a/R/footnote.R
+++ b/R/footnote.R
@@ -3,10 +3,14 @@
 #' Configure options for footnotes.
 #'
 #' @param ref
-#'   One of "1", "a", "A", "i", "I", or "*" to as a choice for a symbol to
-#'   cross-reference footnotes.
+#'   A string or a function that defines symbols of footnote references.
+#'   If the value is string, it must be one of the "1", "a", "A", "i", "I", or
+#'   "*". If a function, it receives an integer vector as an input, and returns
+#'   a character vector with the length equal to the input. The returned values
+#'   will further be processed as markdown strings.
 #' @param prefix,suffix
-#'   Pre- and suf-fixes for `ref` (default: `""`).
+#'   Pre- and suf-fixes for `ref` (default: `""`). These parameters are used
+#'   if and only if ref is a character.
 #' @param start
 #'   A starting number of footnotes.
 #' @param max