From 7dc49f1dbbada61466082df7cfece2b7be45356a Mon Sep 17 00:00:00 2001
From: Ilja Kocken <i.j.kocken@uu.nl>
Date: Tue, 2 May 2023 18:22:19 -1000
Subject: [PATCH] [docs] update cross-linking between functions

---
 R/data.R                | 1 -
 R/get_solution.R        | 2 ++
 R/prepare_solution.R    | 2 +-
 man/ZB18a.Rd            | 3 ---
 man/get_solution.Rd     | 8 ++++++++
 man/prepare_solution.Rd | 2 +-
 6 files changed, 12 insertions(+), 6 deletions(-)

diff --git a/R/data.R b/R/data.R
index 4bcde8f..dd6c4fa 100644
--- 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
index 9f2e049..cdb8ecc 100644
--- 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
index 00d9573..f0d3c58 100644
--- 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
index 11516f8..c897df0 100644
--- a/man/ZB18a.Rd
+++ b/man/ZB18a.Rd
@@ -71,6 +71,3 @@ Zeebe, R. E., & Lourens, L. J. (2019). Solar System chaos and the
 Paleocene–Eocene boundary age constrained by geology and astronomy.
 \emph{Science}, 365(6456), 926–929. \doi{10.1126/science.aax0612}.
 }
-\seealso{
-get_solution get_ZB18a
-}
diff --git a/man/get_solution.Rd b/man/get_solution.Rd
index 6dee608..e29c162 100644
--- a/man/get_solution.Rd
+++ b/man/get_solution.Rd
@@ -14,3 +14,11 @@ or \code{"La11"} (not yet implemented!).}
 \description{
 Get an Orbital Solution
 }
+\references{
+Zeebe, R. E., & Lourens, L. J. (2019). Solar System chaos and the
+Paleocene–Eocene boundary age constrained by geology and astronomy.
+\emph{Science}, 365(6456), 926–929. \doi{10.1126/science.aax0612}.
+}
+\seealso{
+\code{\link[=get_ZB18a]{get_ZB18a()}}
+}
diff --git a/man/prepare_solution.Rd b/man/prepare_solution.Rd
index 733534b..6f8dc12 100644
--- a/man/prepare_solution.Rd
+++ b/man/prepare_solution.Rd
@@ -43,5 +43,5 @@ instantaneous orbital plane.
 }
 }
 \seealso{
-ZB18a \code{\link[=get_solution]{get_solution()}}
+\code{\link[=get_ZB18a]{get_ZB18a()}} \code{\link[=get_solution]{get_solution()}}
 }