Document that aliases should be space separated (not comma).

r-lib · Jun 7, 2024 · 94b7b04 · 94b7b04
1 parent c03a671
commit 94b7b04
Show file tree

Hide file tree

Showing 3 changed files with 5 additions and 5 deletions.
diff --git 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
@@ -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