Skip to content

Commit

Permalink
docs: footnote_option allows function as a value of ref
Browse files Browse the repository at this point in the history
  • Loading branch information
atusy committed Mar 13, 2023
1 parent 4106422 commit 22fa888
Showing 1 changed file with 7 additions and 3 deletions.
10 changes: 7 additions & 3 deletions R/footnote.R
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand Down

0 comments on commit 22fa888

Please sign in to comment.