Change title for reference page (#2475)

To something that isn't so function specific. Fixes #2181.
r-lib · May 3, 2024 · c35fa8c · c35fa8c
1 parent a8e849c
commit c35fa8c
Show file tree

Hide file tree

Showing 4 changed files with 6 additions and 5 deletions.
diff --git a/NEWS.md b/NEWS.md
@@ -1,5 +1,6 @@
 # pkgdown (development version)
 
+* The title for the "Reference" page is now "Package index" since this page might contain more than just function details (#2181).
 * `build_redirects()` now automatically adds redirects for topic 
 aliases. This matches the behaviour of `?` and will help keep links stable in the long term (#1876).
 * `build_redirects()` now reports which redirects it is generating.

diff --git a/R/build-reference-index.R b/R/build-reference-index.R
@@ -19,7 +19,7 @@ data_reference_index <- function(pkg = ".", error_call = caller_env()) {
   rows <- Filter(function(x) !x$is_internal, rows)
 
   print_yaml(list(
-    pagetitle = tr_("Function reference"),
+    pagetitle = tr_("Package index"),
     rows = rows,
     has_icons = has_icons
   ))

diff --git a/po/R-pkgdown.pot b/po/R-pkgdown.pot
@@ -171,7 +171,7 @@ msgid "CRAN release: %s"
 msgstr ""
 
 #: build-reference-index.R:22
-msgid "Function reference"
+msgid "Package index"
 msgstr ""
 
 #: build-reference-index.R:132

diff --git a/tests/testthat/_snaps/build-reference-index.md b/tests/testthat/_snaps/build-reference-index.md
@@ -3,7 +3,7 @@
     Code
       data_reference_index(pkg)
     Output
-      pagetitle: Function reference
+      pagetitle: Package index
       rows:
       - title: A
         slug: a
@@ -100,7 +100,7 @@
     Code
       data_reference_index(pkg)
     Output
-      pagetitle: Function reference
+      pagetitle: Package index
       rows:
       - title: bla
         slug: bla
@@ -160,7 +160,7 @@
     Code
       data_reference_index(pkg)
     Output
-      pagetitle: Function reference
+      pagetitle: Package index
       rows:
       - title: bla
         slug: bla