[docs] update cross-linking between functions

japhir · May 3, 2023 · 7dc49f1 · 7dc49f1
1 parent ab1126c
commit 7dc49f1
Show file tree

Hide file tree

Showing 6 changed files with 12 additions and 6 deletions.
diff --git a/R/data.R b/R/data.R
@@ -66,5 +66,4 @@
 #'   Paleocene–Eocene boundary age constrained by geology and astronomy.
 #'   _Science_, 365(6456), 926–929. \doi{10.1126/science.aax0612}.
 #' @name ZB18a
-#' @seealso get_solution get_ZB18a
 NULL
diff --git a/R/get_solution.R b/R/get_solution.R
@@ -3,6 +3,8 @@
 #' @param orbital_solution Character vector with the name of the orbital
 #'   solution to use. One of `"ZB18a"` (default) from Zeebe and Lourens (2019),
 #'   or `"La11"` (not yet implemented!).
+#' @seealso [get_ZB18a()]
+#' @inherit get_ZB18a references
 get_solution <- function(orbital_solution = "ZB18a") {
   solutions <- c("ZB18a", "La11")
   if (!orbital_solution %in% solutions) {

diff --git a/R/prepare_solution.R b/R/prepare_solution.R
@@ -11,7 +11,7 @@
 #' * `inc` Inclination \eqn{I} (degrees).
 #'
 #' @returns A [tibble][tibble::tibble-package] with the new columns added.
-#' @seealso ZB18a [get_solution()]
+#' @seealso [get_ZB18a()] [get_solution()]
 #'
 #' @details
 #' New columns include:

diff --git a/man/ZB18a.Rd b/man/ZB18a.Rd
diff --git a/man/get_solution.Rd b/man/get_solution.Rd
diff --git a/man/prepare_solution.Rd b/man/prepare_solution.Rd