From 663335ead727ef2dcdab2d799a5b858a3b7e1994 Mon Sep 17 00:00:00 2001
From: James McMahon <james.mcmahon@phs.scot>
Date: Thu, 1 Aug 2024 10:31:40 +0100
Subject: [PATCH] Use `@inheritParams` to simplify documentation

---
 R/get_latest_resource.R    | 14 ++------------
 man/get_latest_resource.Rd |  3 ++-
 2 files changed, 4 insertions(+), 13 deletions(-)

diff --git a/R/get_latest_resource.R b/R/get_latest_resource.R
index 296e459..bf8d6ac 100644
--- a/R/get_latest_resource.R
+++ b/R/get_latest_resource.R
@@ -15,18 +15,8 @@
 #' * prescriptions-in-the-community
 #' * community-pharmacy-contractor-activity
 #'
-#' @param dataset_name name of the dataset as found on
-#' \href{https://www.opendata.nhs.scot/}{NHS Open Data platform}
-#' @param rows (optional) specify the max number of rows to return.
-#' @param row_filters (optional) a named list or vector that specifies values of
-#'  columns/fields to keep.
-#' e.g. list(Date = 20220216, Sex = "Female").
-#' @param col_select (optional) a character vector containing the names of
-#' desired columns/fields.
-#' e.g. c("Date", "Sex").
-#' @param include_context (optional) If `TRUE` additional information about the
-#' resource will be added as columns to the data, including the resource ID, the
-#' resource name, the creation date and the last modified/updated date.
+#' @inheritParams get_dataset
+#' @inheritParams get_resource
 #'
 #' @return a [tibble][tibble::tibble-package] with the data
 #' @export
diff --git a/man/get_latest_resource.Rd b/man/get_latest_resource.Rd
index 02b9f6c..c5e6e7a 100644
--- a/man/get_latest_resource.Rd
+++ b/man/get_latest_resource.Rd
@@ -16,7 +16,8 @@ get_latest_resource(
 \item{dataset_name}{name of the dataset as found on
 \href{https://www.opendata.nhs.scot/}{NHS Open Data platform}}
 
-\item{rows}{(optional) specify the max number of rows to return.}
+\item{rows}{(optional) specify the max number of rows
+to return for each resource.}
 
 \item{row_filters}{(optional) a named list or vector that specifies values of
 columns/fields to keep.