add gtfs_reference to pkgdown reference page

r-transit · Sep 18, 2024 · b8403b3 · b8403b3
1 parent 1a32a05
commit b8403b3
Show file tree

Hide file tree

Showing 3 changed files with 13 additions and 3 deletions.
diff --git a/R/get_gtfs_standards.R b/R/get_gtfs_standards.R
@@ -3,8 +3,10 @@
 #' Generate GTFS standards
 #'
 #' @description
-#' *This function is deprecated and no longer used in [import_gtfs()] or [export_gtfs()].*
+#' The dataset [gtfs_reference] now contains the standard specifications.
+#' This function is deprecated and no longer used in [import_gtfs()] or [export_gtfs()].
 #'
+#' @details
 #' Generates a list specifying the standards to be used when reading and writing
 #' GTFS feeds with R. Each list element (also a list) represents a distinct GTFS
 #' table, and describes:
@@ -44,6 +46,8 @@
 #' - Timezone = `character`
 #' - URL = `character`
 #'
+#' @seealso [gtfs_reference]
+#'
 #' @examples \dontrun{
 #'   gtfs_standards <- get_gtfs_standards()
 #' }

diff --git a/_pkgdown.yml b/_pkgdown.yml
@@ -1,6 +1,7 @@
 reference:
   - title: GTFS standards
   - contents:
+    - gtfs_reference
     - get_gtfs_standards
   - title: Input/output
   - contents:

diff --git a/man/get_gtfs_standards.Rd b/man/get_gtfs_standards.Rd