Merge pull request #301 from frictionlessdata/returns

Use correct roxygen tag `@returns` and Roxygen 8.0.0

Author: peterdesmet

DESCRIPTION

@@ -58,4 +58,4 @@ Config/testthat/edition: 3
 Encoding: UTF-8
 LazyData: true
 Roxygen: list(markdown = TRUE)
-RoxygenNote: 7.3.3
+Config/roxygen2/version: 8.0.0

R/add_resource.R

@@ -37,7 +37,7 @@
 #'   The following properties are automatically set and can't be provided with
 #'   `...`: `name`, `data`, `path`, `schema`, `profile`, `format`, `mediatype`,
 #'   `encoding` and `dialect`.
-#' @return `package` with one additional resource.
+#' @returns `package` with one additional resource.
 #' @family edit functions
 #' @export
 #' @examples

R/check_data.R

@@ -3,7 +3,7 @@
 #' Check if an object is a non-empty data frame.
 #'
 #' @param data A data frame.
-#' @return `data` invisibly or an error.
+#' @returns `data` invisibly or an error.
 #' @family check functions
 #' @noRd
 check_data <- function(data) {

R/check_package.R

@@ -3,7 +3,7 @@
 #' Check if an object is a Data Package object with the required properties.
 #'
 #' @inheritParams read_resource
-#' @return `package` invisibly or an error.
+#' @returns `package` invisibly or an error.
 #' @family check functions
 #' @export
 #' @examples

R/check_path.R

@@ -10,7 +10,7 @@
 #' @param directory Directory to prepend to path.
 #' @param safe Require `path` to be safe, i.e. no absolute or relative parent
 #'   paths.
-#' @return Absolute path or URL or an error.
+#' @returns Absolute path or URL or an error.
 #' @family check functions
 #' @noRd
 check_path <- function(path, directory = NULL, safe = FALSE) {

R/check_schema.R

@@ -5,7 +5,7 @@
 #'
 #' @param schema List describing a Table Schema.
 #' @param data A data frame against which the Table Schema must be compared.
-#' @return `schema` invisibly or an error.
+#' @returns `schema` invisibly or an error.
 #' @family check functions
 #' @noRd
 check_schema <- function(schema, data = NULL) {

R/col_types.R

@@ -3,7 +3,7 @@
 #' Creates a [readr::cols()] for all fields in a Table Schema.
 #'
 #' @inheritParams check_schema
-#' @return A [readr::cols()] object.
+#' @returns A [readr::cols()] object.
 #' @family parse functions
 #' @noRd
 cols <- function(schema) {
@@ -33,7 +33,7 @@ cols <- function(schema) {
 #' Creates a column specification for a specific field in a Table Schema.
 #'
 #' @param field Field in a Table schema.
-#' @return A readr collector.
+#' @returns A readr collector.
 #' @family parse functions
 #' @noRd
 field_to_col <- function(field) {

R/collectors.R

@@ -1,7 +1,7 @@
 #' Parse a string field
 #'
 #' @inheritParams col_number
-#' @return A readr collector.
+#' @returns A readr collector.
 #' @family parse functions
 #' @noRd
 col_string <- function(enum) {
@@ -17,7 +17,7 @@ col_string <- function(enum) {
 #' @param enum A field's `constraints.enum`.
 #' @param group_char A field's `groupChar`.
 #' @param bare_number A field's `bareNumber`.
-#' @return A readr collector.
+#' @returns A readr collector.
 #' @family parse functions
 #' @noRd
 col_number <- function(enum, group_char, bare_number) {
@@ -35,7 +35,7 @@ col_number <- function(enum, group_char, bare_number) {
 #' Parse an integer field
 #'
 #' @inheritParams col_number
-#' @return A readr collector.
+#' @returns A readr collector.
 #' @family parse functions
 #' @noRd
 col_integer <- function(enum, bare_number) {
@@ -51,7 +51,7 @@ col_integer <- function(enum, bare_number) {
 #' Parse a date field
 #'
 #' @inheritParams col_datetime
-#' @return A readr collector.
+#' @returns A readr collector.
 #' @family parse functions
 #' @noRd
 col_date <- function(format) {
@@ -69,7 +69,7 @@ col_date <- function(format) {
 #' Parse a time field
 #'
 #' @inheritParams col_datetime
-#' @return A readr collector.
+#' @returns A readr collector.
 #' @family parse functions
 #' @noRd
 col_time <- function(format) {
@@ -87,7 +87,7 @@ col_time <- function(format) {
 #' Parse a datetime field
 #'
 #' @param format A field's `format`.
-#' @return A readr collector.
+#' @returns A readr collector.
 #' @family parse functions
 #' @noRd
 col_datetime <- function(format) {

R/create_package.R

@@ -17,7 +17,7 @@
 #'
 #' @param descriptor List to be made into a Data Package object.
 #'   If undefined, an empty Data Package will be created from scratch.
-#' @return A Data Package object.
+#' @returns A Data Package object.
 #' @family create functions
 #' @export
 #' @examples

R/create_schema.R

@@ -7,7 +7,7 @@
 #' Data Package standard.
 #'
 #' @param data A data frame.
-#' @return List describing a Table Schema.
+#' @returns List describing a Table Schema.
 #' @family create functions
 #' @export
 #' @examples