From 94b7b04d238e5e55345d323b8cf5f47e43af1397 Mon Sep 17 00:00:00 2001 From: olivroy Date: Thu, 6 Jun 2024 22:26:15 -0400 Subject: [PATCH] Document that aliases should be space separated (not comma). --- DESCRIPTION | 2 +- inst/roxygen2-tags.yml | 4 ++-- man/tags-index-crossref.Rd | 4 ++-- 3 files changed, 5 insertions(+), 5 deletions(-) diff --git a/DESCRIPTION b/DESCRIPTION index 3c9289bf5..9af8e1823 100644 --- a/DESCRIPTION +++ b/DESCRIPTION @@ -53,4 +53,4 @@ Config/testthat/parallel: TRUE Encoding: UTF-8 Language: en-GB Roxygen: list(markdown = TRUE, load = "installed") -RoxygenNote: 7.3.0.9000 +RoxygenNote: 7.3.1.9000 diff --git a/inst/roxygen2-tags.yml b/inst/roxygen2-tags.yml index db439ac07..6aa6b1f18 100644 --- a/inst/roxygen2-tags.yml +++ b/inst/roxygen2-tags.yml @@ -1,9 +1,9 @@ - name: aliases description: > - Add additional aliases to the topic. + Add one or more additional aliases to the topic (separated by spaces). Use `NULL` to suppress the default alias automatically generated by roxygen2. - template: ' ${1:alias}' + template: ' ${1:alias1} ${2:alias2}' vignette: index-crossref recommend: true diff --git a/man/tags-index-crossref.Rd b/man/tags-index-crossref.Rd index b8e4aec48..bbde523ca 100644 --- a/man/tags-index-crossref.Rd +++ b/man/tags-index-crossref.Rd @@ -11,7 +11,7 @@ \alias{@seealso} \title{Tags for indexing and cross-references} \usage{ -#' @aliases ${1:alias} +#' @aliases ${1:alias1} ${2:alias2} #' @backref ${1:path} #' @concept ${1:concept} #' @family ${1:family name} @@ -24,7 +24,7 @@ Learn the full details in \code{vignette('index-crossref')}. Key tags: \itemize{ -\item \verb{@aliases $\{1:alias\}}: Add additional aliases to the topic. +\item \verb{@aliases $\{1:alias1\} $\{2:alias2\}}: Add one or more additional aliases to the topic (separated by spaces). Use \code{NULL} to suppress the default alias automatically generated by roxygen2. \item \verb{@concept $\{1:concept\}}: Add additional keywords or phrases to be included in the \code{help.search()} index. Each \verb{@concept} should be a single term or phrase. \item \verb{@family $\{1:family name\}}: Generate \verb{@seealso} entries to all other functions in \verb{family name}.