Convert a Validator to Plain Text

Produces a single-line text summary suitable for roxygen @param documentation. Use with inline R code in roxygen: `r as_contract_text(validator)`.

Usage

as_contract_text(x)

Arguments

x

a restriction object.

Value

A character(1) string describing the validation contract.

See also

Other core: as_contract_block(), fail(), require_custom(), restrict()

Examples

v <- restrict("x") |> require_numeric(no_na = TRUE) |> require_length(1L)
as_contract_text(v)
#> [1] "Must be numeric, no NA. Must have length 1."