Skip to content

Commit

Permalink
Stop the man pages being created for internal functions
Browse files Browse the repository at this point in the history
Also made `find_latest_file` internal i.e. not exported.
  • Loading branch information
Moohan committed Jul 22, 2024
1 parent eef04c1 commit 7ba5037
Show file tree
Hide file tree
Showing 6 changed files with 5 additions and 72 deletions.
2 changes: 1 addition & 1 deletion DESCRIPTION
Original file line number Diff line number Diff line change
Expand Up @@ -28,4 +28,4 @@ Config/testthat/edition: 3
Encoding: UTF-8
LazyData: true
Roxygen: list(markdown = TRUE)
RoxygenNote: 7.3.1
RoxygenNote: 7.3.2
1 change: 0 additions & 1 deletion NAMESPACE
Original file line number Diff line number Diff line change
@@ -1,6 +1,5 @@
# Generated by roxygen2: do not edit by hand

export(find_latest_file)
export(get_hscp_locality)
export(get_simd_datazone)
export(get_simd_postcode)
Expand Down
4 changes: 2 additions & 2 deletions R/find_latest_file.R
Original file line number Diff line number Diff line change
Expand Up @@ -14,15 +14,15 @@
#' (the default) or "file_name".
#'
#' @return the [fs::path()] to the file
#' @export
#'
#' @examples
#' \dontrun{
#' find_latest_file(
#' directory = "/conf/linkage/output/lookups/Unicode",
#' regexp = "Scottish_Postcode_Directory_.+?\\.rds"
#' )
#' }
#' @noRd
#' @keywords internal
find_latest_file <- function(directory,
regexp,
selection_method = "modification_date") {
Expand Down
2 changes: 2 additions & 0 deletions R/read_file.R
Original file line number Diff line number Diff line change
Expand Up @@ -11,6 +11,8 @@
#' @param ... Addition arguments passed to the relevant function.
#'
#' @return the data a [tibble][tibble::tibble-package]
#' @noRd
#' @keywords internal
read_file <- function(path, col_select = NULL, as_data_frame = TRUE, ...) {
valid_extensions <- c(
"rds",
Expand Down
35 changes: 0 additions & 35 deletions man/find_latest_file.Rd

This file was deleted.

33 changes: 0 additions & 33 deletions man/read_file.Rd

This file was deleted.

0 comments on commit 7ba5037

Please sign in to comment.