check_field: Syntactical check of a DESCRIPTION field

View source: R/syntax_checks.R

check_fieldR Documentation

Syntactical check of a DESCRIPTION field

Description

Syntactical check of a DESCRIPTION field

Usage

check_field(x, warn = FALSE, ...)

Arguments

x

The field.

warn

Whether to generate a warning if the syntax check fails.

...

Additional arguments, they might be used in the future.

Value

TRUE if the field is syntactically correct, otherwise a character vector, containing one or multiple error messages.


metacran/description documentation built on Jan. 16, 2024, 10:12 p.m.