Merge pull request #134 from Public-Health-Scotland/docs/fix_user_fac…

…ing_internal_func Remove make_inheritance_checks.R from the user facing docs
Public-Health-Scotland · Aug 30, 2024 · f38d440 · f38d440
2 parents be9170d + 7a8de80
commit f38d440
Show file tree

Hide file tree

Showing 4 changed files with 37 additions and 26 deletions.
diff --git a/DESCRIPTION b/DESCRIPTION
@@ -56,5 +56,5 @@ Encoding: UTF-8
 Language: en-GB
 LazyData: true
 Roxygen: list(markdown = TRUE)
-RoxygenNote: 7.2.3
+RoxygenNote: 7.3.2
 VignetteBuilder: knitr
diff --git a/R/make_inheritance_checks.R b/R/make_inheritance_checks.R
@@ -6,7 +6,8 @@
 #' @param target_classes character vector of the classes to check for.
 #' @param ignore_null boolean. Indicates whether to ignore arguments with value
 #' NULL (TRUE) or to throw an exception (FALSE). Default = TRUE.
-
+#' @internal
+#' @noRd
 make_inheritance_checks <- function(arguments,
                                     target_classes,
                                     ignore_null = TRUE) {

diff --git a/man/make_inheritance_checks.Rd b/man/make_inheritance_checks.Rd
diff --git a/man/phsmethods.Rd b/man/phsmethods.Rd