pkgdown/mathjax-config.html

Skip to contents

Produces a multi-line text summary suitable for roxygen @details documentation. Each step appears on its own line as a bullet point.

Usage

as_contract_block(x)

Arguments

x

a restriction object.

Value

A character(1) string with one step per line.

Examples

v <- restrict("x") |> require_numeric(no_na = TRUE) |> require_length(1L)
as_contract_block(v)
#> [1] "- must be numeric, no NA\n- must have length 1"