Preserve order of aliases

NEWS.md

@@ -1,5 +1,8 @@
 # roxygen2 5.0.1.9000
 
+* `@aliases` are no longer sorted in alphabetical order, but will instead
+  match the order of the usage. This gives you more control in pkgdown.
+
 * `@author` is now rendered after `@seealso`.
 
 * `"_PACKAGE"` documentation now generates a default `@seealso` combining

R/field.R

@@ -58,16 +58,20 @@ format.roxy_field_backref <- function(x, ...) {
 
 # Fields that repeat multiple times --------------------------------------------
 
-format_rd <- function(x, ...) {
-  vapply(sort_c(unique(x$values)), rd_macro, field = x$field,
+format_rd <- function(x, ..., sort = TRUE) {
+  if (sort) {
+    x$values <- sort_c(unique(x$values))
+  }
+
+  vapply(x$values, rd_macro, field = x$field,
     FUN.VALUE = character(1), USE.NAMES = FALSE)
 }
 #' @export
 format.roxy_field_keyword <- format_rd
 #' @export
 format.roxy_field_alias <- function(x, ...) {
   x$values <- str_replace_all(x$values, fixed("%"), "\\%")
-  format_rd(x, ...)
+  format_rd(x, ..., sort = FALSE)
 }
 
 # Fields that keep the first occurence -----------------------------------------

tests/testthat/test-rd-alias.R

@@ -13,19 +13,19 @@ test_that("aliases split into pieces", {
 
 test_that("aliases escaped, not quoted", {
   out1 <- roc_proc_text(rd_roclet(), "
+    #' @name %a%
     #' @aliases a
     #' @title a
-    #' @name %a%
     NULL")[[1]]
   out2 <- roc_proc_text(rd_roclet(), "
+    #' @name a
     #' @aliases %a%
     #' @title a
-    #' @name a
     NULL")[[1]]
   alias1 <- format(get_tag(out1, "alias"))
   alias2 <- format(get_tag(out2, "alias"))
   expect_equal(alias1, c("\\alias{\\%a\\%}\n", "\\alias{a}\n"))
-  expect_equal(alias2, c("\\alias{\\%a\\%}\n", "\\alias{a}\n"))
+  expect_equal(alias2, c("\\alias{a}\n", "\\alias{\\%a\\%}\n"))
 })
 
 test_that("can use NULL to suppress default aliases", {